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
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
get
GET /tenants/{tenantId}/onboard/name/{tenantName}/availability HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "tenantName": "text",
  "nameAvailable": true,
  "reason": "Invalid"
}

Last updated