API ReferenceTenants
Create tenant
Analytics Events
TENANT_CREATE_STARTTENANT_CREATE_SUCCESSTENANT_CREATE_FAIL
POST
/v1/tenantsCreates a new tenant in the requested environment.
Analytic events
- TENANT_CREATE_START
- TENANT_CREATE_SUCCESS
- TENANT_CREATE_FAIL
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
text/plain
curl -X POST "https://example.com/v1/tenants" \ -H "Content-Type: application/json" \ -d '{ "subdomain": "string", "environmentId": "string" }'{ "id": "string", "name": "string", "subdomain": "string", "environment": { "id": "string", "name": "string", "domain": "string", "authorizationServerDomain": "string", "deploymentModel": "public", "region": { "id": "string", "name": "string", "displayName": "string" } }, "membership": { "roles": [ "string" ] }, "client": { "clientId": "stringstringstringstringstringst", "clientSecret": "string" }}How would you rate this page?
Retrieve environments GET
Retrieves a list of all available environments. ### **Analytic events** * ENVIRONMENT_RETRIEVE_LIST_START * ENVIRONMENT_RETRIEVE_LIST_SUCCESS * ENVIRONMENT_RETRIEVE_LIST_FAIL
Retrieve tenants GET
Retrieves a list of all available tenants. If you haven't created any tenants, the response will include an empty array. ### **Analytic events** * TENANT_RETRIEVE_LIST_START * TENANT_RETRIEVE_LIST_SUCCESS * TENANT_RETRIEVE_LIST_FAIL