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

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

tenantIdstring · uuidRequired

Expects Id of an existing tenant

tenantNamestringRequired

Expects name for tenant onboarding availablility check

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Indicates that name availablility check was successful, name may or may not be available

text/plainapplication/jsontext/json

Class for name availablity.

tenantNamestring · nullableOptional

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.

nameAvailablebooleanOptional

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.

reasonstring · enumOptional

Enum for tenant name availablity.

Possible values:

404

Indicates that the requested tenant does not exist

text/plainapplication/jsontext/json

500

Server related error

text/plainapplication/jsontext/json

get

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

HTTPcURLJavaScriptPython

GET /tenants/{tenantId}/onboard/name/{tenantName}/availability HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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