light-mode-image
Learn
API ReferenceTenants

Delete tenant

Analytics Events

TENANT_DELETE_STARTTENANT_DELETE_SUCCESSTENANT_DELETE_FAIL
DELETE/v1/tenants/{tenantId}

Deletes a tenant by its ID.

Analytic events

  • TENANT_DELETE_START
  • TENANT_DELETE_SUCCESS
  • TENANT_DELETE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Unique ID of the tenant to delete.

Formatuuid

Response Body

application/json

text/plain

application/json

curl -X DELETE "https://manage.au01.mattr.global/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "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?

Retrieve tenant GET

Retrieves a tenant by its ID. ### **Analytic events** * TENANT_RETRIEVE_START * TENANT_RETRIEVE_SUCCESS * TENANT_RETRIEVE_FAIL

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. > **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](/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. ### **Analytic events** * TENANT_MEMBER_INVITATION_CREATE_START * TENANT_MEMBER_INVITATION_CREATE_SUCCESS * TENANT_MEMBER_INVITATION_CREATE_FAIL