API docs by Redocly

Ayra™ TRQP Profile API (1.0.0)

Download OpenAPI specification:Download

This specification defines a RESTful TRQP profile for use in the Ayra™ Trust Network. It includes endpoints for retrieving Trust Registry metadata, authorization data, verifying entity authorization status, and checking ecosystem recognition.

trqp

TRQP Compliant Queries

Retrieve Trust Registry Metadata

Returns Trust Registry Metadata as a JSON object.

query Parameters
egf_did
string

An optional identifier specifying which ecosystem's metadata should be retrieved.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "default_egf_did": "string",
  • "description": "string",
  • "name": "string",
  • "controllers": [
    ]
}

Check Entity Authorization Status

Determines if the specified entity (entity_id) is authorized under the given authorization identifier (authorization_id) within the specified governance framework (ecosystem_did). Optionally, returns a list of authorizations if all is true.

path Parameters
entity_id
required
string

Unique identifier of the entity.

query Parameters
authorization_id
required
string

Authorization identifier to evaluate.

ecosystem_did
required
string

Unique identifier of the governance framework.

all
required
boolean

Whether to return a list of authorizations.

time
string <date-time>

ISO8601/RFC3339 timestamp for authorization status evaluation. Defaults to the current time if omitted.

Responses

Response samples

Content type
application/json
[ ]

Check Ecosystem Recognition

Verifies if the specified ecosystem (egf_target) is recognized under the given governance framework (egf_source).

path Parameters
ecosystem_did
required
string

Unique identifier of the ecosystem being queried.

query Parameters
egf_did
required
string

Unique identifier of the governance framework. Defaults to single egf_did of the Trust Registry itself.

time
string <date-time>

RFC3339 timestamp indicating when recognition is checked. Defaults to "now" on system being queried.

Responses

Response samples

Content type
application/json
{
  • "recognized": true,
  • "message": "string",
  • "egf_did": "string",
  • "evaluated_at": "2019-08-24T14:15:22Z",
  • "response_time": "2019-08-24T14:15:22Z",
  • "expiry_time": "2019-08-24T14:15:22Z",
  • "jws": "string"
}

extensions

Ayra™ Extensions to TRQP

Retrieve Entity Information

Retrieves information about a specific entity.

path Parameters
entity_id
required
string

A unique identifier for the entity.

Responses

Response samples

Content type
application/json
{ }

List Recognized Ecosystems

Retrieves a collection of recognized ecosystems for a specified governance framework.

path Parameters
ecosystem_did
required
string

Unique identifier of the ecosystem being queried.

query Parameters
egf_did
string

Optional identifier of the governance framework to filter the response. All EGFs supported by the ecosystem will be used when not provided.

time
string <date-time>

RFC3339 timestamp indicating when recognition is checked.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Supported Assurance Levels

Retrieves the supported assurance levels for the specified ecosystem.

path Parameters
ecosystem_did
required
string

Unique identifier of the ecosystem being queried.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Authorizations

Performs an authorization lookup based on the provided ecosystem identifier.

path Parameters
ecosystem_did
required
string

Ecosystem identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Supported DID Methods

Retrieves the supported DID Methods. AYRA is opinionated here.

path Parameters
ecosystem_did
required
string

Unique identifier of the ecosystem being queried.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]