External Policies

Returns the list of requests for adding remote policies.

get

Returns the list of requests for adding remote policies.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberOptional

The numbers of items to return

Example: 20

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/external-policies

GET /api/v1/external-policies HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Policy Name",
    "description": "Policy Description",
    "version": "1.0.0",
    "topicId": "0.0.6046379",
    "instanceTopicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "policyTag": "Tag",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "status": "DRAFT",
    "username": "Username"
  }
]

Returns preview of the remote policies.

post

Returns preview of the remote policies.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

messageIdstringRequired

Hedera topic message id

Responses

200

Policy preview.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/external-policies/preview

POST /api/v1/external-policies/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1773670900.819264517"
}

{
  "policy": {
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Test policy",
    "version": "1.0.0",
    "description": "",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "instanceTopicId": "0.0.6046379",
    "policyTag": "Tag_1773682447599",
    "codeVersion": "1.5.1",
    "tools": [],
    "id": "69aeb71ef8c5b278e3bab4e5"
  },
  "tokens": [],
  "schemas": [],
  "systemSchemas": []
}

Creates a request to import a remote policy.

post

Creates a request to import a remote policy.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

messageIdstringRequired

Hedera topic message id

Responses

200

Policy.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/external-policies/import

POST /api/v1/external-policies/import HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1773670900.819264517"
}

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Policy Name",
  "description": "Policy Description",
  "version": "1.0.0",
  "topicId": "0.0.6046379",
  "instanceTopicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyTag": "Tag",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "username": "Username"
}

Approves the request to import a remote policy, and imports it.

post

Approves the request to import a remote policy, and imports it.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Responses

202

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

Item not found.

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/external-policies/push/{messageId}/approve

POST /api/v1/external-policies/push/{messageId}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 0
}

Rejects the request to import a remote policy.

post

Rejects the request to import a remote policy.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Responses

202

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

Item not found.

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/external-policies/push/{messageId}/reject

POST /api/v1/external-policies/push/{messageId}/reject HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 0
}

Approves the request to import a remote policy, and imports it.

post

Approves the request to import a remote policy, and imports it.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

Item not found.

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/external-policies/{messageId}/approve

POST /api/v1/external-policies/{messageId}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Rejects the request to import a remote policy.

post

Rejects the request to import a remote policy.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

Item not found.

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/external-policies/{messageId}/reject

POST /api/v1/external-policies/{messageId}/reject HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Disconnects the user from the selected remote policy on the current Guardian instance only.

put

Disconnects the user from the selected remote policy on the current Guardian instance only.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Query parameters

fullbooleanOptional

Disconnects the user from the selected remote policy on the current Guardian instance and from the same policy on the Main Guardian instance where it is deployed.

Example: 0

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

put

/external-policies/{messageId}/disconnect

PUT /api/v1/external-policies/{messageId}/disconnect HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Removes the remote policy from the current Guardian instance.

delete

Removes the remote policy from the current Guardian instance.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/external-policies/{messageId}

DELETE /api/v1/external-policies/{messageId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Returns the list of requests for action from remote Guardians.

get

Returns the list of requests for action from remote Guardians.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberOptional

The numbers of items to return

Example: 20

policyIdstringOptional

Policy Id

Example: 001

statusstringOptional

Status

Example: NEW

typestringOptional

Type

Example: ACTION

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/external-policies/requests

GET /api/v1/external-policies/requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "type": "ACTION",
    "messageId": "1773670900.819264517",
    "startMessageId": "1773670900.819264517",
    "status": "NEW",
    "lastStatus": "NEW",
    "accountId": "0.0.6046379",
    "sender": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "document": {},
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "blockTag": "Tag",
    "policyMessageId": "1773670900.819264517",
    "loaded": true
  }
]

Approves a request for an action from a remote Guardian.

put

Approves a request for an action from a remote Guardian.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Body

uuidstringRequired

Action UUID

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

typestring · enumRequired

Action type

Example: ACTIONPossible values:

messageIdstringRequired

Action message id

Example: 1773670900.819264517

startMessageIdstringRequired

Action start message id

Example: 1773670900.819264517

statusstring · enumRequired

Action status

Example: NEWPossible values:

lastStatusstring · enumRequired

Action last status

Example: NEWPossible values:

accountIdstringRequired

Action owner

Example: 0.0.6046379

senderstringRequired

Message sender

Example: 0.0.6046379

ownerstringRequired

Action owner

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

topicIdstringRequired

Action topic id

Example: 0.0.6046379

policyIdstringRequired

Policy UU

Example: 69aeb71ef8c5b278e3bab4e5

blockTagstringRequired

Block tag

Example: Tag

policyMessageIdstringRequired

Policy message id

Example: 1773670900.819264517

loadedbooleanRequired

File is loaded

Example: true

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

put

/external-policies/requests/{messageId}/approve

PUT /api/v1/external-policies/requests/{messageId}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "status": "NEW",
  "document": {}
}

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "startMessageId": "1773670900.819264517",
  "status": "NEW",
  "lastStatus": "NEW",
  "accountId": "0.0.6046379",
  "sender": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "document": {},
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "blockTag": "Tag",
  "policyMessageId": "1773670900.819264517",
  "loaded": true
}

Rejects a request for an action from a remote Guardian

put

Rejects a request for an action from a remote Guardian

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Policy message id

Example: 1773670900.819264517

Body

uuidstringRequired

Action UUID

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

typestring · enumRequired

Action type

Example: ACTIONPossible values:

messageIdstringRequired

Action message id

Example: 1773670900.819264517

startMessageIdstringRequired

Action start message id

Example: 1773670900.819264517

statusstring · enumRequired

Action status

Example: NEWPossible values:

lastStatusstring · enumRequired

Action last status

Example: NEWPossible values:

accountIdstringRequired

Action owner

Example: 0.0.6046379

senderstringRequired

Message sender

Example: 0.0.6046379

ownerstringRequired

Action owner

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

topicIdstringRequired

Action topic id

Example: 0.0.6046379

policyIdstringRequired

Policy UU

Example: 69aeb71ef8c5b278e3bab4e5

blockTagstringRequired

Block tag

Example: Tag

policyMessageIdstringRequired

Policy message id

Example: 1773670900.819264517

loadedbooleanRequired

File is loaded

Example: true

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

put

/external-policies/requests/{messageId}/reject

PUT /api/v1/external-policies/requests/{messageId}/reject HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "status": "NEW",
  "document": {}
}

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "startMessageId": "1773670900.819264517",
  "status": "NEW",
  "lastStatus": "NEW",
  "accountId": "0.0.6046379",
  "sender": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "document": {},
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "blockTag": "Tag",
  "policyMessageId": "1773670900.819264517",
  "loaded": true
}

Cancels a request for an action from a remote Guardian

put

Cancels a request for an action from a remote Guardian

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Action Identifier

Example: 1773670900.819264517

Body

uuidstringRequired

Action UUID

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

typestring · enumRequired

Action type

Example: ACTIONPossible values:

messageIdstringRequired

Action message id

Example: 1773670900.819264517

startMessageIdstringRequired

Action start message id

Example: 1773670900.819264517

statusstring · enumRequired

Action status

Example: NEWPossible values:

lastStatusstring · enumRequired

Action last status

Example: NEWPossible values:

accountIdstringRequired

Action owner

Example: 0.0.6046379

senderstringRequired

Message sender

Example: 0.0.6046379

ownerstringRequired

Action owner

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

topicIdstringRequired

Action topic id

Example: 0.0.6046379

policyIdstringRequired

Policy UU

Example: 69aeb71ef8c5b278e3bab4e5

blockTagstringRequired

Block tag

Example: Tag

policyMessageIdstringRequired

Policy message id

Example: 1773670900.819264517

loadedbooleanRequired

File is loaded

Example: true

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

put

/external-policies/requests/{messageId}/cancel

PUT /api/v1/external-policies/requests/{messageId}/cancel HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "status": "NEW",
  "document": {}
}

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "startMessageId": "1773670900.819264517",
  "status": "NEW",
  "lastStatus": "NEW",
  "accountId": "0.0.6046379",
  "sender": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "document": {},
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "blockTag": "Tag",
  "policyMessageId": "1773670900.819264517",
  "loaded": true
}

Reloads a request for an action from a remote Guardian

put

Reloads a request for an action from a remote Guardian

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

messageIdstringRequired

Action Identifier

Example: 1773670900.819264517

Body

uuidstringRequired

Action UUID

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

typestring · enumRequired

Action type

Example: ACTIONPossible values:

messageIdstringRequired

Action message id

Example: 1773670900.819264517

startMessageIdstringRequired

Action start message id

Example: 1773670900.819264517

statusstring · enumRequired

Action status

Example: NEWPossible values:

lastStatusstring · enumRequired

Action last status

Example: NEWPossible values:

accountIdstringRequired

Action owner

Example: 0.0.6046379

senderstringRequired

Message sender

Example: 0.0.6046379

ownerstringRequired

Action owner

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

topicIdstringRequired

Action topic id

Example: 0.0.6046379

policyIdstringRequired

Policy UU

Example: 69aeb71ef8c5b278e3bab4e5

blockTagstringRequired

Block tag

Example: Tag

policyMessageIdstringRequired

Policy message id

Example: 1773670900.819264517

loadedbooleanRequired

File is loaded

Example: true

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

put

/external-policies/requests/{messageId}/reload

PUT /api/v1/external-policies/requests/{messageId}/reload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "status": "NEW",
  "document": {}
}

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "type": "ACTION",
  "messageId": "1773670900.819264517",
  "startMessageId": "1773670900.819264517",
  "status": "NEW",
  "lastStatus": "NEW",
  "accountId": "0.0.6046379",
  "sender": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "document": {},
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "blockTag": "Tag",
  "policyMessageId": "1773670900.819264517",
  "loaded": true
}

Returns the count of entries in the list of requests for actions from remote Guardians.

get

Returns the count of entries in the list of requests for actions from remote Guardians.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

policyIdstringOptional

Policy Id

Example: 001

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/external-policies/requests/count

GET /api/v1/external-policies/requests/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requestsCount": 0,
  "actionsCount": 0,
  "delayCount": 0,
  "total": 0
}

Returns the request document by startMessageId.

get

Returns the request document by startMessageId.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startMessageIdstringRequired

Start Message Id

Example: 1773670900.819264517

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/external-policies/requests/document

GET /api/v1/external-policies/requests/document?startMessageId=1773670900.819264517 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "result": "ok"
}

Last updated 5 days ago