Skip to main content
POST
create-tenant

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
key
string
fields
any
credentials
any
aiCreditsRolling30DayLimit
number | null
Required range: x >= 0
isTest
boolean

[INTERNAL] Whether this tenant is a workspace member/test tenant.

isReadOnly
boolean

[INTERNAL] Workspace-role-derived read-only capability flag.

kind
enum<string>

[INTERNAL] Tenant principal kind.

Available options:
member,
operator,
virtual

Response

200 - application/json

Create a tenant in the current workspace.

id
string
required
name
string
required
meta
object
key
string
kind
enum<string>
Available options:
member,
operator,
virtual
isReadOnly
boolean
fields
object
credentials
any
lastActiveAt
string
isTest
boolean
isBillable
boolean
isActive
boolean
aiCreditsRolling30DayLimit
number | null
Required range: x >= 0
createdAt
string
archivedAt
string