Tenant Management
Create a tenant

How to create a tenant


Make a request of the following structure to create a new tenant in your environment:

    "name": "My First Tenant",
    "subdomain": "tenants-test-subdomain",
    "environmentId": "4b69a1d6-1f4d-4df7-a149-c4bb89c5d000"
  • name : The name that will be used to identify this tenant.
  • subdomain : The subdomain that will be used to access this tenant. Only lower case alphanumeric characters (a-z, 0-9) and hyphens are allowed.
  • environmentId : The unique identifier of the environment where the new tenant will be created. You can make a different request to retrieve all environments you have permissions to manage..


    "id": "6facbcef-66cd-4a06-89e3-e44a4fc12000",
    "name": "My First Tenant",
    "subdomain": "",
    "environment": {
        "id": "4b69a1d6-1f4d-4df7-a149-c4bb89c5d000",
        "name": "Public Australia Sydney",
        "domain": "vii.a01.mattr,global",
        "deploymentModel": "public",
        "authorizationServerDomain": "",
        "region": {
            "id": "0fd6ce12-a983-41d0-aca8-03e1bb6f6000",
            "name": "au01",
            "displayName": "Sydney, Australia"
    "client": {
        "clientId": "MjQx108p***************FlwJQjy",
        "clientSecret": "NanfSkVr**********************PfD3zJ"
  • id : Globally unique tenant identifier.
  • name : As set in the request.
  • subdomain : The tenant URL, constructed with the subdomain you provided in the request.
  • environment : Indicates data for the environment in which the new tenant was created.
  • client : Indicates the tenant clientId and clientSecret. Make sure you store these securely for future authentication.

Your clientSecret is only available in this response and cannot be retrieved later. However, you can make a request to retrieve your clientId.