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-core

TRQP Compliant Queries

Queries registry for Authorization, by an Ecosystem, of an Entity.

Request Body schema: application/json
entity_id
required
string

Unique identifier of the TRUST REGISTRY (identified by DID) that is the subject of the query. This is the 'EntityX` in the "Does EntityX have AuthorityY in EcosystemZ?".

authority_id
required
string

Unique identifier of the ECOSYSTEM (identified by DID) that is being queried. This is the "EcosystemZ" in the "Does EntityX have AuthorityY in EcosystemZ?".

action
required
string

The action that the query is checking Authorization for.

resource
required
string

The resource that the query is is checking Authorization for.

object

A flexible context object that can hold arbitrary key-value pairs.

  • NOTE: time is codified as it is a standard context to be considered.

Responses

Request samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "action": "string",
  • "resource": "string",
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "action": "string",
  • "resource": "string",
  • "assertion_verified": true,
  • "time_requested": "2019-08-24T14:15:22Z",
  • "time_evaluated": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "context": {
    }
}

Queries registry for recognition, by an ecosystem, of another ecosystem.

Request Body schema: application/json
entity_id
required
string <URI>

Unique identifier of the TRUST REGISTRY (identified by DID) that is the subject of the query. This is the "other trust registry" in the "Does your ecosystem recognized this other trust registry as assertion_id?".

authority_id
required
string <URI>

Unique identifier of the ECOSYSTEM (identified by DID) that is being queried. This is the "your ecosystem" in the "Does your ecosystem recognize this other trust registry as assertion_id?".

action
required
string

The action that the query is checking Recognition for.

resource
required
string

The resource that the query is is checking Recognition for.

object

A flexible context object that can hold arbitrary key-value pairs.

  • NOTE: time is codified as it is a standard context to be considered.

Responses

Request samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "action": "string",
  • "resource": "string",
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "entity_id": "string",
  • "authority_id": "string",
  • "action": "string",
  • "resource": "string",
  • "recognized": true,
  • "time_requested": "2019-08-24T14:15:22Z",
  • "time_evaluated": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "context": {
    }
}

ayra-extension

Ayra Extensions to TRQP

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
{
  • "ecosystem_did": "string",
  • "trustregistry_did": "string",
  • "egf_did": "string",
  • "description": "string",
  • "name": "string",
  • "controllers": [
    ],
  • "additionalProperties": "string"
}

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 Authorizations that this Entity has

Retrieves a collection of authorizations that this entity has, according to the ecosystem queried.

path Parameters
ecosystem_did
required
string

Unique identifier of the ecosystem being queried.

query Parameters
time
string <date-time>

RFC3339 timestamp indicating when recognition is checked.

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
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.

query Parameters
ecosystem_did
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. These strings can be used in TRQP queries for this ecosystem (as assertion_id values in the TRQP queries).

query Parameters
ecosystem_did
string

Ecosystem identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Supported DID Methods

Retrieves the supported DID Methods. AYRA is opinionated here.

query Parameters
ecosystem_did
string

Unique identifier of the ecosystem being queried.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

lookup

Lookup capability ()

Lookup Supported Assurance Levels

Retrieves the supported assurance levels for the specified ecosystem.

query Parameters
ecosystem_did
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. These strings can be used in TRQP queries for this ecosystem (as assertion_id values in the TRQP queries).

query Parameters
ecosystem_did
string

Ecosystem identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Supported DID Methods

Retrieves the supported DID Methods. AYRA is opinionated here.

query Parameters
ecosystem_did
string

Unique identifier of the ecosystem being queried.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]