Tenant - Checks updated tenant name availability

Checks the availability of an updated name for the requested tenant.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

tenantIdstring · uuidRequired

Enter the ID of an existing tenant.

tenantNamestringRequired

Enter the updated name to check for availability when renaming a tenant.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Success: Name availability check successful; availability status may vary.

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

Not Found: Indicates that the requested tenant does not exist.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

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

HTTPcURLJavaScriptPython

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

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