POST 
/trusted-policies-registry/v2/jsonrpc

The JSON-RPC API provides methods assisting the construction of blockchain transactions and interaction with the ledger.

Request

application/json

Bodyrequired

The body follows the JSON-RPC 2.0 specification.

It requires the following fields:

• jsonrpc: must be exactly "2.0"
• method: method to be invoked
• params: method parameters
• id: identifier established by the client

API Methods

insertPolicy

Call to build an unsigned transaction to insert a policy in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• opType: operation type. 0 = "AND", 1 = "OR"
• policyName: name of the policy.
• description: description.
• policyConditions: array of condition objects:
  • name: name of the condition
  • attributeName: name of the attribute on which it applies
  • value: value to compare to
  • typeOfValue: value type. 0 = "UINT256", 1 = "BYTES", 2 = "ADDRESS", 3= "BYTES32", 4 = "STRING", 5 = "BOOLEAN"
  • attributeOperation: operation to apply. 0 = "EQUAL"

updatePolicy

Call to build an unsigned transaction to update a policy. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• policyId: Policy ID
• policyName: Policy Name
• opType: operation type. 0 = "AND", 1 = "OR"
• description: description.

Use either policyId OR policyName to identify the policy, but not both.

addPolicyConditions

Call to build an unsigned transaction to add conditions to an existing policy in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• policyId: Policy ID
• policyName: Policy Name
• policyConditions: array of condition objects:
  • name: name of the condition
  • attributeName: name of the attribute on which it applies
  • value: value to compare to
  • typeOfValue: value type. 0 = "UINT256", 1 = "BYTES", 2 = "ADDRESS", 3= "BYTES32", 4 = "STRING", 5 = "BOOLEAN"
  • attributeOperation: operation to apply. 0 = "EQUAL"

Use either policyId OR policyName to identify the policy, but not both.

deletePolicyCondition

Call to build an unsigned transaction to delete a condition from an existing policy in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• policyId: Policy ID
• policyName: Policy Name
• policyConditionId:: ID of the policy condition to remove

Use either policyId OR policyName to identify the policy, but not both.

deactivatePolicy

Call to build an unsigned transaction to deactivate a policy in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• policyId: ID of the policy to deactivate
• policyName: Policy Name

Use either policyId OR policyName to identify the policy, but not both.

activatePolicy

Call to build an unsigned transaction to activate a policy in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• policyId: ID of the policy to activate
• policyName: Policy Name

Use either policyId OR policyName to identify the policy, but not both.

insertUserAttributes

Call to build an unsigned transaction to insert user attributes in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• address: user address
• attributeNames: attribute names
• attributeValues: attribute values

updateUserAttribute

Call to build an unsigned transaction to update an user attribute in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• address: user address
• attributeName: attribute name
• attributeValue: attribute value

deleteUserAttribute

Call to build an unsigned transaction to delete an user attribute in the registry. This method requires OPERATOR ROLE in the Trusted Policies Registry.

Parameters:

• from: Ethereum address of the signer
• address: user address
• attributeName: attribute name

sendSignedTransaction

Call to send a signed transaction to the blockchain.

jsonrpc stringrequired

Must be exactly "2.0"

method stringrequired

Method that needs to be invoked

params object[]required

Array of parameters

id integerrequired

Identifier established by the client

Responses

200

Response

application/json

Schema

Schema

jsonrpc string

Must be exactly "2.0"

id integer

Same identifier established by the client in the call

result object
Result of the call
oneOf
MOD2
string

Build tx

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "from": "0x416e6e6162656c2e4c65652e452d412d506f652e",
    "to": "0xFde86148db58f57787C06BeAf63a9c3f789357b3",
    "data": "0x0000...",
    "nonce": "0x00",
    "chainId": "0x1b3b",
    "gasLimit": "0x10000",
    "gasPrice": "0x00",
    "value": "0x00"
  }
}

Send Transaction

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
}

400

Bad request

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Bad Request

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad request."
}

Loading...