light-mode-image
Learn
API ReferenceMembers

Retrieve tenant members

Analytics Events

TENANT_MEMBER_RETRIEVE_LIST_STARTTENANT_MEMBER_RETRIEVE_LIST_SUCCESSTENANT_MEMBER_RETRIEVE_LIST_FAIL
GET/v1/tenants/{tenantId}/members

Retrieves a list of all users that have access to the tenant.

Analytic events

  • TENANT_MEMBER_RETRIEVE_LIST_START
  • TENANT_MEMBER_RETRIEVE_LIST_SUCCESS
  • TENANT_MEMBER_RETRIEVE_LIST_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Identifier of the tenant to retrieve.

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

application/json

application/json

text/plain

curl -X GET "https://example.com/v1/tenants/543e0579-87b9-4705-be78-8f7f54709838/members"
{  "data": [    {      "id": "string",      "email": "string",      "name": "string",      "status": "Pending",      "roles": [        "string"      ],      "permissions": [        "string"      ],      "inviteExpiresAt": "2019-08-24T14:15:22Z",      "isSSO": true,      "isLocalLogin": true,      "isMfaEnabled": true,      "lastLoginAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}

How would you rate this page?

Invite a tenant member POST

Invites a user to join the tenant and assigns roles to them within the tenant's context. If the user has not registered to the Self Service Portal yet, then they will receive an email with a link to accept the invite. If the user has already registered, then they will be added as a member to the tenant immediately. <Callout> This endpoint can only be called by a Portal user that is a member of the tenant. Machine-to-machine (M2M) clients are not currently supported as inviters and will receive a `404 Resource Not Found` response, even when the client holds an `admin` role. This applies regardless of the role assigned, such as `admin`, `issuer`, or `dts-provider`. To invite members, use a Portal user that is a member of the target tenant. A reliable workflow is to create the tenant from the [MATTR Portal](/docs/platform-management/portal) rather than via an M2M client. The Portal user that creates the tenant becomes a member automatically, and can then invite additional users to it, either from the Portal UI or by calling this endpoint with the Portal user's access token. </Callout> ### **Analytic events** * TENANT_MEMBER_INVITATION_CREATE_START * TENANT_MEMBER_INVITATION_CREATE_SUCCESS * TENANT_MEMBER_INVITATION_CREATE_FAIL

Retrieve a tenant member GET

Retrieves an existing user that has access to the tenant. ### **Analytic events** * TENANT_MEMBER_RETRIEVE_START * TENANT_MEMBER_RETRIEVE_SUCCESS * TENANT_MEMBER_RETRIEVE_FAIL