AssignedRole

object

An assigned role is a role that has been assigned to a user or team.

idstring(uuid)

The ID of the role assignment.

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestring

Name of the role being assigned.

Example:Viewer

entity_idstring(uuid)

A RBAC entity ID.

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestring

Name of the entity type the role is being assigned to.

Example:Control Planes

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

Example

System Account

object

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

Example

System Account Access Token

object

Schema of the system account access token.

idstring(uuid)read-only

ID of the system account access token.

namestring

Name of the system account access token.

created_atstring(date-time)read-only

Timestamp of when the system account access token was created.

updated_atstring(date-time)read-only

Timestamp of when the system account access token was last updated.

expires_atstring(date-time)

Timestamp of when the system account access token will expire.

last_used_atstring(date-time)read-only

Timestamp of when the system account access token was last used.

Example

PATName

string

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 256 characters

PersonalAccessTokenCreateRequestWithExpiresAt

object

Deprecated: Use ttl_seconds instead of expires_at to specify token expiration. Using a time-to-live value avoids clock skew issues when setting token expiration.

* Additional properties are NOT allowed.
namestringrequired

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 256 characters

expires_atstring(date-time)required

An ISO-8601 timestamp representation of entity expiration date.

Example:2022-11-04T20:10:06.927Z

Example