Retrieve clients

GET

/v1/tenants/{tenantId}/clients

Retrieves a list of clients authorized to interact with the requested tenant.

Analytics Events

TENANT_CLIENT_RETRIEVE_LIST_STARTTENANT_CLIENT_RETRIEVE_LIST_SUCCESSTENANT_CLIENT_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Path Parameters

tenantId*string

Unique ID of the tenant to retrieve clients for.

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

Clients retrieved

application/json

response

data*array<>

nextCursor?nextCursor

Starting point for next cursor to use in a paginated list.

curl -X GET "https://example.com/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/clients"

{  "data": [    {      "clientId": "suC7IhmDIawnlqBlEOuIqBWoqppcdI52",      "name": "Example client",      "permissions": [        "dids:read",        "dids:create"      ],      "roles": [        "issuer"      ]    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

GET

/v1/tenants/{tenantId}/clients

Retrieves a list of clients authorized to interact with the requested tenant.

Analytics Events

TENANT_CLIENT_RETRIEVE_LIST_STARTTENANT_CLIENT_RETRIEVE_LIST_SUCCESSTENANT_CLIENT_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

headerAuthorizationBearer <token>

Path Parameters

tenantId*string

Unique ID of the tenant to retrieve clients for.

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

Clients retrieved

application/json

response

data*array<>

nextCursor?nextCursor

Starting point for next cursor to use in a paginated list.

curl -X GET "https://example.com/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/clients"

{  "data": [    {      "clientId": "suC7IhmDIawnlqBlEOuIqBWoqppcdI52",      "name": "Example client",      "permissions": [        "dids:read",        "dids:create"      ],      "roles": [        "issuer"      ]    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve clients

Analytics Events

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Query Parameters

Response Body

Authorization

Path Parameters

Query Parameters

Response Body