Create Tenant Account

Body Params
string
required

Tenant name.

string

Logo URL.

string
required

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

string
required

Owner OpenID. Only taken into account if the logged-in user is an Admin, otherwise will use the logged-in user's OpenID.

string

This is the region in which the data should be stored. Possible values: US, Canada, EU.

string
enum

Default Identity Provider (Keycloak or Auth0 -default-).

Allowed:
string
enum

Defines the types of Subscriptions that can be purchased for the Tenant in the future.

Allowed:
boolean
Defaults to false

Skip subdomain creation.

string

Realm name for authentication. If not provided, defaults to KEYCLOAK_REALM_NAME configuration value.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json