Skip to main content
PATCH
/
v1
/
regions
/
global
/
organizations
/
{id}
Update organization
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayName: '<string>', description: '<string>'})
};

fetch('https://api.k0rdent.ai/v1/regions/global/organizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "selfLink": "/v1/regions/global/organizations/org-s1t2u3",
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "org-s1t2u3",
  "displayName": "<string>",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

​
id
string<uuid>
required

Unique organization identifier

Body

application/json

Request to update organization configuration

​
displayName
string

Updated human-friendly display name for the organization.

​
description
string

Updated description of this resource.

Response

Organization updated successfully

Customer organization (tenant)

​
selfLink
string<uri>

Server-defined URL for this resource.

Example:

"/v1/regions/global/organizations/org-s1t2u3"

​
uid
string<uuid>

Server-generated UUID.

​
id
string

Name of the resource. Provided by the client when the resource is created, or generated by the server if not specified. Must be 1-63 characters long and match the pattern a-z? — the first character must be a lowercase letter, and all following characters must be lowercase letters, digits, or hyphens, with the last character being a letter or digit. Cannot be changed after the resource is created.

Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
Example:

"org-s1t2u3"

​
displayName
string

Optional human-friendly display name for the organization.

​
description
string

An optional description of this resource.