Create a tenant under the current team
This endpoint creates a new tenant under your team. Upon successful creation, the response includes the tenant’s details and management client credentials. The tenant type (public or private) is determined by the attributes in the request payload. Refer to the payload schema for required attributes.
Documentation Index
Fetch the complete documentation index at: https://docs-dev.auth0-mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ボディ
Create a tenant under the current team
- Public Cloud
- Private Cloud
The email of the person that will be added as an admin of the tenant. The person must be a member of the team.
Specifies the Auth0 Public Cloud locality where the tenant will be created.
Available localities include United States (us), Europe (eu), Australia (au), Japan (jp), Canada (ca) and United Kingdom (uk).
2 - 5"us"
"eu"
"au"
"jp"
"ca"
"uk"
The tenant name uniquely identifies a tenant programmatically and within various dashboards, such as Auth0 Dashboard. It can only contain alphanumeric characters, lowercase letters and "-". However, it can't start nor end with "-". If not specified, a tenant name will be auto-generated.
3 - 63^[a-z0-9][-a-z0-9]{1,62}[a-z0-9]$"acme-development-tenant"
Specifies the Environment tag for the tenant created in the Auth0 Public Cloud. It is used to distinguish between development, staging and production environments.
Development and Staging environments are intended for testing and pre-production use, while production is designated for live applications and subject to higher rate limits. Selecting the correct environment type ensures appropriate resource allocation and rate limits
development, production, staging "development"
レスポンス
Tenant Created
- Public Cloud
- Private Cloud
The unique identifier of the created tenant (UUID). This identifier is required for performing operations such as deleting the tenant. UUIDs ensure global uniqueness and are essential for managing tenant resources programmatically
"538c9e21-e3d5-4ad6-b3d0-352c62369fb0"
The tenant name uniquely identifies a tenant programmatically and within various dashboards, such as Auth0 Dashboard. It can only contain alphanumeric characters, lowercase letters and "-". However, it can't start nor end with "-". If not specified, a tenant name will be auto-generated.
3 - 63^[a-z0-9][-a-z0-9]{1,62}[a-z0-9]$"acme-development-tenant"
The fully qualified domain name of the tenant, which uniquely identifies its domain within the system. The domain is used to define the audience when interacting with the Management API, enabling programmatic management of the tenant’s configuration and resources.
"acme-development-tenant.us.auth0.com"
"acme-development-tenant.acme-dev.auth0app.com"
Locality in which the tenant was created
"us"
"eu"
"virginia"
"frankfurt"
The name of the cloud environment where the tenant was created
"US-3"
"EU-1"
"acme-dev"
The date and time when the tenant was created, formatted in ISO 8601 standard. This timestamp ensures consistency across time zones and systems
The Auth0 Management Client credentials required to authenticate and interact with the newly created tenant. These credentials allow authorized access to manage the tenant's configuration, resources, and API interactions.
Specifies the Environment tag for the tenant created in the Auth0 Public Cloud. It is used to distinguish between development, staging and production environments.
Development and Staging environments are intended for testing and pre-production use, while production is designated for live applications and subject to higher rate limits. Selecting the correct environment type ensures appropriate resource allocation and rate limits
development, production, staging "development"