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

fetch('https://api.k0rdent.ai/v1/regions/global/iam/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "user-v5w6x7",
  "email": "jsmith@example.com",
  "displayName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "selfLink": "/v1/regions/global/iam/users/user-v5w6x7",
  "roles": [
    "<string>"
  ],
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

​
id
string
required

Unique user identifier

Body

application/json
​
displayName
string

Updated user display name

​
roles
string[]

Updated role assignments

​
status
enum<string>

User account status

Available options:
active,
suspended,
disabled

Response

User successfully updated

User account object.

​
uid
string<uuid>
required
read-only

Server-generated UUID.

​
id
string
required

Resource identifier. Provided by the client at creation or server-generated if omitted. Must be 1-63 lowercase characters matching a-z [blocked]?. Immutable after creation.

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

"user-v5w6x7"

​
email
string<email>
required

User email address

​
displayName
string
required

User display name

Required string length: 1 - 255
​
status
enum<string>
required
read-only

User account status

Available options:
active,
suspended,
disabled
​
createdAt
string<date-time>
required
read-only

User creation timestamp

​
selfLink
string<uri>
read-only

Server-defined URL for this resource.

Example:

"/v1/regions/global/iam/users/user-v5w6x7"

​
roles
string[]

Assigned role identifiers

​
updatedAt
string<date-time>
read-only

User last update timestamp