Update Tenant Name Endpoint

POST

/user/rename-tenant

curl --request POST \
  --url https://example.com/user/rename-tenant \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-UserKey: <X-Tenzir-UserKey>' \
  --data '{ "tenant_id": "example", "name": "example" }'

Authorizations

• User Key

Request Body ^required

Media type application/json

RenameTenantRequest

object

tenant_id

required

Tenant Id

string

name

required

Name

string

Example ^generated

{
  "tenant_id": "example",
  "name": "example"
}

Responses

200

Successful Response

Media type application/json

RenameTenantResponse

object

Example ^generated

{}

403

{"detail": "Invalid API Key"} {"detail": "Not permitted to access this tenant"}

404

{"detail": "Tenant not found"}

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"
    }
  ]
}