For more details about the Quorum permissions JSON-RPC APIs
- Source:
Methods
(inner) acctList() → {Array.<Object>}
- Source:
Returns:
The list of accounts permissioned in the network
- Type
- Array.<Object>
(inner) addAccountToOrg(acctId, orgId, roleId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
acctId |
String | org or sub org id to which the role belongs |
orgId |
String | org id |
roleId |
String | role id |
Returns:
response message
- Type
- String
(inner) addNewRole(orgId, roleId, accountAccess, isVoter, isAdminRole) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org id for which the role is being created |
roleId |
String | unique role identifier |
accountAccess |
String | account level access. Refer for complete list |
isVoter |
Boolean | bool indicates if its a voting role |
isAdminRole |
Boolean | bool indicates if its an admin role |
Returns:
response message
- Type
- String
(inner) addNode(orgId, enodeId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id to which the node belongs |
enodeId |
String | complete enode id |
Returns:
response message
- Type
- String
(inner) addOrg(orgId, enodeId, accountId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | unique org identfier |
enodeId |
String | complete enode id |
accountId |
String | account which will be the org admin account |
Returns:
response message
- Type
- String
(inner) addSubOrg(parentOrgId:, subOrgId:, enodeId:) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parentOrgId: |
String | parent org id |
subOrgId: |
String | sub org identifier |
enodeId: |
String | complete enode id of the node linked to the sub org id |
Returns:
response message
- Type
- String
(inner) approveAdminRole(orgId, acctId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id to which the node belongs |
acctId |
String | blacklisted account id |
Returns:
response message
- Type
- String
(inner) approveBlackListedAccountRecovery(orgId, acctId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id to which the node belongs |
acctId |
String | blacklisted account id |
Returns:
response message
- Type
- String
(inner) approveBlackListedNodeRecovery(orgId, enodeId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id to which the node belongs |
enodeId |
String | complete enode id |
Returns:
response message
- Type
- String
(inner) approveOrg(orgId, enodeId, accountId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | unique org identfier |
enodeId |
String | complete enode id |
accountId |
String | account which will be the org admin account |
Returns:
response message
- Type
- String
(inner) approveOrgStatus(orgId, action) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | |
action |
Number | 1 - for approving org suspension, 2 - for approving activation of suspended org |
Returns:
response message
- Type
- String
(inner) assignAdminRole(orgId, acctId, roleId)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org id to which the account belongs |
acctId |
String | account id |
roleId |
String | new role id to be assigned to the account. This can be the network admin role or org admin role only |
Returns:
(inner) changeAccountRole(acctId, orgId, roleId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
acctId |
String | account id |
orgId |
String | org id |
roleId |
String | new role id to be assigned to the account |
Returns:
response message
- Type
- String
(inner) connectionAllowed(enodeId, ipAddress, portNum) → {Boolean}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
enodeId |
String | enode id |
ipAddress |
String | IP address of the node |
portNum |
Number | port number |
Returns:
status indicating if connection is allowed or not
- Type
- Boolean
(inner) getOrgDetails(orgId) → {Array.<Object>}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id |
Returns:
The list of accounts, nodes, roles, and sub organizations linked to an organization
- Type
- Array.<Object>
(inner) nodeList() → {Array.<Object>}
- Source:
Returns:
The list of nodes permissioned in the network
- Type
- Array.<Object>
(inner) orgList() → {Array.<Object>}
- Source:
Returns:
The list of all organizations with the status of each organization in the network
- Type
- Array.<Object>
(inner) recoverBlackListedAccount(orgId, acctId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id to which the node belongs |
acctId |
String | blacklisted account id |
Returns:
response message
- Type
- String
(inner) recoverBlackListedNode(orgId, enodeId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id to which the node belongs |
enodeId |
String | complete enode id |
Returns:
response message
- Type
- String
(inner) removeRole(orgId, roleId) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org or sub org id to which the role belongs |
roleId |
String | role id |
Returns:
response message
- Type
- String
(inner) roleList() → {Array.<Object>}
- Source:
Returns:
The list of roles in the network
- Type
- Array.<Object>
(inner) transactionAllowed(txArgs:) → {Boolean}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
txArgs: |
Object | transaction arguments object |
Returns:
status indicating if transaction is allowed or not
- Type
- Boolean
(inner) updateAccountStatus(orgId, acctId, action) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org id |
acctId |
String | org or sub org id to which the role belongs |
action |
String | 1 - for suspending the account, 2 - for activating a suspended account, 3 - for blacklisting an account |
Returns:
response message
- Type
- String
(inner) updateNodeStatus(orgId, enodeId, action) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | org id |
enodeId |
String | complete enode id |
action |
String | 1 - for deactivating the node, 2 - for activating a deactivated node, 3 - for blacklisting a node |
Returns:
response message
- Type
- String
(inner) updateOrgStatus(orgId, action) → {String}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
orgId |
String | |
action |
Number | 1 - for suspending a org, 2 - for activating a suspended organization |
Returns:
response message
- Type
- String