light-mode-image
Learn
API ReferenceMembers

Invite a tenant member

Analytics Events

TENANT_MEMBER_INVITATION_CREATE_STARTTENANT_MEMBER_INVITATION_CREATE_SUCCESSTENANT_MEMBER_INVITATION_CREATE_FAIL
POST/v1/tenants/{tenantId}/invitations

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.

Note: 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 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.

Analytic events

  • TENANT_MEMBER_INVITATION_CREATE_START
  • TENANT_MEMBER_INVITATION_CREATE_SUCCESS
  • TENANT_MEMBER_INVITATION_CREATE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Identifier of the tenant to add the member to.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

text/plain

application/json

curl -X POST "https://manage.au01.mattr.global/v1/tenants/543e0579-87b9-4705-be78-8f7f54709838/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "john-doe@example.com",    "roles": [      "dts-provider",      "issuer"    ]  }'
{
  "userId": "8f6d40a9-d913-45e8-aa3e-8c99d62cd8fb",
  "status": "Active",
  "inviteExpiresAt": "2025-08-22T07:46:09.510Z"
}
{
  "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"
    }
  ]
}
Empty

How would you rate this page?

Delete tenant DELETE

Deletes a tenant by its ID. ### **Analytic events** * TENANT_DELETE_START * TENANT_DELETE_SUCCESS * TENANT_DELETE_FAIL

Retrieve tenant members GET

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