Create Tenant Endpoint

POST

/admin/create-tenant

curl --request POST \
  --url https://example.com/admin/create-tenant \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-AdminKey: <X-Tenzir-AdminKey>' \
  --data '{ "owner": { "namespace": "user", "owner_id": "example", "display_name": "example" }, "name": "example", "icon_url": "example" }'

Authorizations

• Admin Key

Request Body ^required

Media type application/json

CreateTenantV2Request

Create a new tenant. Will return an error if that user already owns a tenant.

object

owner

required

TenantOwner

object

namespace

required

Namespace

string

Allowed values: user team organization static-configuration dcso-organization

owner_id

required

Owner Id

string

display_name

Any of:

string

string

null

null

name

Any of:

string

string

null

null

icon_url

Any of:

string

string

null

null

Responses

200

Successful Response

Media type application/json

CreateTenantV2Response

Application facing subset of the tenant model.

object

tenant_id

required

Tenant Id

string

create_date_time

required

Create Date Time

string

nodes

required

Nodes

Array<object>

NodeResponse

The node part of a tenant response.

object

name

required

Name

string

node_id

required

Node Id

string

create_date_time

required

Create Date Time

string

destroy_date_time

required

Any of:

string

string

null

null

last_known_version

required

Any of:

string

string

null

null

last_known_features

required

Last Known Features

Array<string>

demo

required

Demo

boolean

ephemeral

Ephemeral

boolean

Example

{
  "nodes": [
    {
      "ephemeral": false
    }
  ]
}

400

{"detail": "Given user already has tenant {tenant_id}"}

403

{"detail": "Invalid API Key"}

422

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

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}