TRQP Restful Binding (1.0.0)

Download OpenAPI specification:Download

This specification defines a RESTful TRQP Binding. 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_id
string

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

Responses

Response samples

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

Check Ecosystem Recognition

Verifies if the specified ecosystem (ecosystem_id) is recognized under the given governance framework (egf_id).

path Parameters
ecosystem_id
required
string

Unique identifier of the ecosystem being queried.

query Parameters
egf_id
required
string

Unique identifier of the governance framework. Defaults to single egf_id 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_id": "string",
  • "evaluated_at": "2019-08-24T14:15:22Z",
  • "response_time": "2019-08-24T14:15:22Z",
  • "expiry_time": "2019-08-24T14:15:22Z",
  • "jws": "string"
}

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 (egf_id). 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.

egf_id
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
[ ]