Tenant - Checks tenant name availability

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

get

Authorizations

Path parameters

tenantIdstring · uuidRequired

Enter the ID of an existing tenant.

tenantNamestringRequired

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

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Responses

200

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

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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

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