Sign in
Platform

Rename Tenant

Changed on

Required role: owner.

Change a tenant's name. Only the name changes: pipelines, API keys, members and OIDC trust relationships all reference the tenant by its identifier and are unaffected.

Set displace_existing to replace a tenant atomically with one that's currently in use. This renames the conflicting tenant to <name> (<id>) in the same transaction, with everything it had. Two calls potentially lose to another user request, which could re-create the name in between.

patch/v0/tenants/{tenant_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

tenant_idstring required

Tenant identifier

Request body

displace_existingboolean

Take the name from the tenant that currently holds it, instead of failing with a conflict. That tenant is renamed to <name> (<id>) and keeps everything it had; nothing is merged or deleted.

namestring required

The tenant's new name.

Example request

{
  "name": "acme"
}

Response

Tenant renamed

Changes