Skip to content

Create New Tenant

POST
/v1/platform/tenants
curl --request POST \
--url http://localhost:8080/v1/platform/tenants \
--header 'Content-Type: application/json' \
--data '{ "id": "example", "name": "example", "initial_admin_email": "hello@example.com" }'
Media type application/json
CreateTenantPayload
object
id
required
Id
string
/^[a-z0-9][a-z0-9\-]{1,62}$/
name
required
Name
string
>= 1 characters <= 256 characters
initial_admin_email
required
Initial Admin Email
string format: email
Example generated
{
"id": "example",
"name": "example",
"initial_admin_email": "hello@example.com"
}

Successful Response

Media type application/json
Response Create New Tenant V1 Platform Tenants Post
object
key
additional properties
any
Example generated
{}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}