Tenant - Checks tenant name availability

Checks the availability of a name for onboarding a given tenant.

GET/tenants/{tenantId}/onboard/name/{tenantName}/availability

Authorization

Bearer

Path parameters

tenantId*string (uuid)

Enter the ID of an existing tenant.

tenantName*string

Enter the name to check for availability when onboarding a tenant.

Query parameters

Response

200404500

Success: Name availability check successful; name may or may not be available.

Body

text/plainapplication/jsontext/json

tenantNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the tenantId property.

nameAvailableboolean

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the tenantName property.

reasonenum

Enum for tenant name availablity.

InvalidAlreadyExistsNone

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tenants/{tenantId}/onboard/name/{tenantName}/availability', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "tenantName": "text",
  "nameAvailable": false,
  "reason": "Invalid"
}