Skip to main content

Create tenant

Create tenant

Request Body REQUIRED
active boolean
authClientId string

Possible values: 1 ≤ length ≤ 40, Value must match regular expression [a-z0-9_-].*

Id of authentication clientId, a default when not specified

authRealm string

Possible values: 1 ≤ length ≤ 10, Value must match regular expression [a-z0-9_-].*

Id of authentication realm, 'shortName' when not specified

customDomain string

Possible values: length ≤ 255

displayName string REQUIRED

Possible values: 1 ≤ length ≤ 255

favicon string

Possible values: length ≤ 5000

headlineFont string

Possible values: length ≤ 30

imprintUrl string REQUIRED

Possible values: length ≤ 2048

logo string REQUIRED

Possible values: length ≤ 10000

primaryColor string REQUIRED

Possible values: length ≤ 10, Value must match regular expression [#A-Za-z0-9].*

privacyPolicyUrl string REQUIRED

Possible values: length ≤ 2048

shortName string REQUIRED

Possible values: 1 ≤ length ≤ 10, Value must match regular expression [a-z0-9_-].*

supportUrl string

Possible values: length ≤ 2048

tenantId int32 REQUIRED

Possible values: 1 ≤ value

termsOfUseUrl string REQUIRED

Possible values: length ≤ 2048

Responses
201

Tenant successfully created

Schema OPTIONAL
active boolean OPTIONAL
authClientId string OPTIONAL
authRealm string OPTIONAL
customDomain string OPTIONAL
displayName string OPTIONAL
id uuid OPTIONAL
legalInformation object OPTIONAL
imprintUrl string OPTIONAL
privacyPolicyUrl string OPTIONAL
supportUrl string OPTIONAL
termsOfUseUrl string OPTIONAL
shortName string OPTIONAL
subdomainName string OPTIONAL
tenantId int32 OPTIONAL
theming object OPTIONAL
favicon string OPTIONAL
headlineFont string OPTIONAL
logo string OPTIONAL
primaryColor string OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL