Learn

Tenants

Retrieve tenants

Retrieves a list of all available tenants. If you haven't created any tenants, the response will include an empty array.

Analytic events

  • TENANT_RETRIEVE_LIST_START
  • TENANT_RETRIEVE_LIST_SUCCESS
  • TENANT_RETRIEVE_LIST_FAIL
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of the list, default 100

Example: limit=2
cursor
string

Starting point for the list

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

A list of tenants

400

Bad Request. The request was malformed or missing required parameters.

401

Unauthorized. The client is not authorized to access this resource.

403

Forbidden. The authorization server refuses to grant the client access to the resource.

500

Internal Server Error. An unexpected error occurred.

get/v1/tenants
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
Create tenant
Creates a new tenant in the requested environment.


Analytic events


    

  • TENANT_CREATE_START
    • 

  • TENANT_CREATE_SUCCESS
    • 

  • TENANT_CREATE_FAIL
    • 



SecuritybearerAuth 
Request 
Request Body schema: application/json
required
name
string
Friendly and/or meaningful name for your new tenant.


 
subdomain
required
string
Subdomain for your tenant within requested environment. Only lower case alphanumeric characters (a-z, 0-9) and hyphens are allowed.


 
environmentId
required
string
Unique identifier of the environment where you want to create your tenant. This can be obtained by retrieving environments.


 
Responses 
201
Tenant created


400
Bad Request


401
Unauthorized. The client is not authorized to access this resource.


403
Forbidden. The authorization server refuses to grant the client access to the resource.


500
Internal Server Error. An unexpected error occurred.


503
Service Unavailable. The server is temporarily unavailable to handle requests.


post/v1/tenants
Request samples 
application/json
{
  • "name": "My Tenant",
  • "subdomain": "my-tenant",
  • "environmentId": "84ca6f53-5405-4413-a6ad-848b781807e7"
}
Response samples 
application/json
{
  • "id": "86cb97a9-5e80-4ed7-af13-a170752bb1ea",
  • "name": "My Tenant",
  • "subdomain": "my-tenant.vii.mattr.global",
  • "environment": {
    },
  • "client": {
    }
}
Retrieve tenant
Retrieves a tenant by its ID.


Analytic events


    

  • TENANT_RETRIEVE_START
    • 

  • TENANT_RETRIEVE_SUCCESS
    • 

  • TENANT_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
tenantId
required
string <uuid> 
Unique ID of the tenant to retrieve.


 
Responses 
200
Tenant retrieved


400
Bad Request. The request was malformed or missing required parameters.


401
Unauthorized. The client is not authorized to access this resource.


403
Forbidden. The authorization server refuses to grant the client access to the resource.


404
Not Found. The specified resource was not found.


500
Internal Server Error. An unexpected error occurred.


get/v1/tenants/{tenantId}
Request samples 
Response samples 
application/json
{
  • "id": "86cb97a9-5e80-4ed7-af13-a170752bb1ea",
  • "name": "My Tenant",
  • "subdomain": "my-tenant.vii.mattr.global",
  • "environment": {
    }
}
Delete tenant
Deletes a tenant by its ID.


Analytic events


    

  • TENANT_DELETE_START
    • 

  • TENANT_DELETE_SUCCESS
    • 

  • TENANT_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
tenantId
required
string <uuid> 
Unique ID of the tenant to delete.


 
Responses 
204
Tenant deleted


400
Bad Request. The request was malformed or missing required parameters.


401
Unauthorized. The client is not authorized to access this resource.


403
Forbidden. The authorization server refuses to grant the client access to the resource.


404
Not Found. The specified resource was not found.


500
Internal Server Error. An unexpected error occurred.


delete/v1/tenants/{tenantId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
Retrieve clients
Retrieves a list of clients authorised to interact with the requested tenant.


Analytic events


    

  • TENANT_CLIENT_RETRIEVE_LIST_START
    • 

  • TENANT_CLIENT_RETRIEVE_LIST_SUCCESS
    • 

  • TENANT_CLIENT_RETRIEVE_LIST_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
tenantId
required
string <uuid> 
Unique ID of the tenant to retrieve clients for.


 
query Parameters
limit
number  [ 1 .. 1000 ] 
 Default:  100
Range size of the list, default 100


 
 Example:  limit=2
cursor
string
Starting point for the list


 
 Example:  cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses 
200
Clients retrieved


400
Bad Request. The request was malformed or missing required parameters.


401
Unauthorized. The client is not authorized to access this resource.


403
Forbidden. The authorization server refuses to grant the client access to the resource.


404
Not Found. The specified resource was not found.


500
Internal Server Error. An unexpected error occurred.


get/v1/tenants/{tenantId}/clients
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
➔ Next to Security