Updates a tenant

PUT 
https://apis.<domain>/iam/tenants/:id

Updates the name of an existing tenant.

Authorization Action:

iam:tenants:update

Request

Path Parameters

id stringrequired

Unique ID. Cannot be changed.

application/json

Body

required

name stringrequired

Name for the tenant.

Responses

200

A successful response.

application/json

Schema

Schema

tenant object

name string

Name for the tenant.

id string

Unique ID. Cannot be changed.

type compiuta.api.iam.v2.Type

Possible values: [COMPIUTA_MANAGED, CUSTOM]

Default value: COMPIUTA_MANAGED

Example (from schema)

{
  "name": "My Custom Tenant",
  "id": "custom-tenant"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://apis.<domain>/iam/tenants/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "My Custom Tenant"
}'

Request Collapse all

Base URL

https://apis.<domain>

Parameters

id — pathrequired

Body required

{
  "name": "My Custom Tenant"
}