Skip to main content
GET
/
v1
/
regions
/
global
/
iam
/
roles
/
{id}
Retrieve role details
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.k0rdent.ai/v1/regions/global/iam/roles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "viewer",
  "displayName": "Viewer",
  "permissions": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "selfLink": "/v1/regions/global/iam/roles/viewer",
  "description": "<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 role identifier

Response

Role details

RBAC role definition. For MVP, roles are a predefined set of system roles and cannot be created or modified via the API.

​
uid
string<uuid>
required

Server-generated UUID.

​
id
enum<string>
required

Well-known role identifier. Predefined system roles are owner, admin, member, and viewer. Must match a-z?. Immutable.

Available options:
owner,
admin,
member,
viewer
Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
Example:

"viewer"

​
displayName
string
required

Human-readable display name for the role.

Required string length: 1 - 255
Example:

"Viewer"

​
permissions
string[]
required

List of permissions granted by this role

​
createdAt
string<date-time>
required

Role creation timestamp

​
selfLink
string<uri>

Server-defined URL for this resource.

Example:

"/v1/regions/global/iam/roles/viewer"

​
description
string

Human-readable role description

​
updatedAt
string<date-time>

Role last update timestamp