Operator: every registered integrating party and the principals tied to it (REQ-ID-7).

GET

/v1/ops/integrating-parties

const url = 'https://example.com/v1/ops/integrating-parties';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/ops/integrating-parties \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

The answer, from one consistent view (REQ-QR-2).

application/json

GET /v1/ops/integrating-parties.

object

items

required

Every registered party, in identifier order.

Array<object>

A registered integrating party, as the operator lists it (REQ-ID-7).

object

party

required

The party: its organisation identity, did:-shaped.

string

principals

required

Its principals, in identifier order.

Array<object>

A principal tied to an integrating party.

object

principal

required

The principal, did:-shaped.

string

tied_at

required

When it was tied.

integer format: uint64

registered_at

required

When it was registered.

integer format: uint64

Example^generated

{
  "items": [
    {
      "party": "example",
      "principals": [
        {
          "principal": "example",
          "tied_at": 1
        }
      ],
      "registered_at": 1
    }
  ]
}

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).

Operator: every registered integrating party and the principals tied to it (REQ-ID-7).

Authorizations

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated