Skip to navigation
REST APIOrganizationsTenant

Create tenant

View as Markdown

Authentication

AuthorizationBearer
Bearer authentication

Request

The tenant to create.
namestringRequiredformat: "^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$"2-255 characters
The name of the tenant.
emailstringRequiredformat: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"5-254 characters
The email of the tenant's admin user.
aliasstring or nullOptionalformat: "^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$"2-255 characters
An optional alias for the tenant. Must be unique across all tenant names and aliases.
passwordstring or nullOptional8-255 characters
The password for the tenant's admin user. Must contain at least 1 special character, 1 uppercase letter, 1 lowercase letter, 1 digit, and be at least 8 characters long.
contractTypeenumOptional
Allowed values:
roleenumOptional

The role assigned to the tenant’s admin user. Possible value: System administrator.

Allowed values:
metricStoreobject or nullOptional

Response

Created
tenantobject
additionalDataobject or nullOptional
additional data for tenant creation

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error