Tenant - Check if the name for any given tenant is available

Checks if a name for onboarded any given tenant is available or not

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

Authorization

Bearer

Path parameters

tenantId*string (uuid)

Expects Id of an existing tenant

tenantName*string

Expects name for tenant onboarding availablility check

Query parameters

Response

200404500

Indicates that name availablility check was 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"
}