The account an alias names, for a principal that reaches it; ERR-UnknownAccount otherwise, and ERR-IdentifierArchived for a prior system's identifier the initial state left out (REQ-RC-7).

GET

/v1/aliases

const url = 'https://example.com/v1/aliases';
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/aliases \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Query Parameters

name

The name within it.

string | null

source

The source, as register_alias takes it.

string | null

Responses

200

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

application/json

alias(source, name) (REQ-RC-7): the account an alias names.

object

account

required

The account, did:-shaped.

string

Example^generated

{
  "account": "example"
}

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

The account an alias names, for a principal that reaches it; ERR-UnknownAccount otherwise, and ERR-IdentifierArchived for a prior system's identifier the initial state left out (REQ-RC-7).

Authorizations

Parameters

Query Parameters

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated