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

Bodyrequired

namestringrequired

Name for the tenant.

Responses

200

A successful response.

application/json

Schema

Schema

tenant object
namestring
Name for the tenant.
idstring
Unique ID. Cannot be changed.
typecompiuta.api.iam.v2.Type (string)
Possible values: [COMPIUTA_MANAGED, CUSTOM]
Default value: COMPIUTA_MANAGED

Example (auto)

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

default

An unexpected error response.

application/json

Schema

Schema

codeinteger<int32>
messagestring
details object[]
Array [
@typestring
property name*any
]

Example (auto)

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

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://apis.<domain>/iam/tenants/:id");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"name\": \"My Custom Tenant\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://apis.<domain>

Parameters

id — pathrequired

Body required

{
  "name": "My Custom Tenant"
}