MATTR Learn

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

GET/v1/tenants/{tenantId}/clients

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantIdstring

Unique ID of the tenant to retrieve clients for.

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Default100

Range1 <= value <= 1000

cursor?string

Starting point for the list of entries.

Response Body

curl -X GET "https://manage.mattr.global/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"

curl -X GET "https://manage.mattr.global/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"

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

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

"Unauthorized"

Empty

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}