Skip to navigation
REST APIAuthentication and AuthorizationRoles

Get a role by id.

View as Markdown
Retrieves details for a specific role, including its name, description, scope, and associated permission sets.

Authentication

AuthorizationBearer
Bearer authentication

Path parameters

roleIdPathintegerRequired>=0
The ID of the role

Response

Executed successfully.
namestring>=1 character
The name of the role to create. Must be unique within the given scope.
descriptionstring
A description of the role.
idinteger
The ID of the role.
createdAtdatetime
The timestamp for when the role was created.
updatedAtdatetime
The timestamp for the last time the role was updated.
createdBystring
Identifier of the user who created the role.
effectiveEnabledbooleanDefaults to true

Indicates whether the role is effectively enabled in the tenant. This reflects the role’s operational state after considering tenant-level configuration or restrictions. Default: true

permissionslist of objects
scopeTypeenumOptionalDefaults to tenant

The type of scope where the role applies. Valid values: system, tenant

Allowed values:
scopeIdstring or nullOptional
The ID of the scope where this role is defined.
enabledboolean or nullOptionalDefaults to true

Specifies whether the role is active. Default: true

permissionSetslist of objectsOptional
The permission sets assigned to this role. Each item includes the UUID and name of the permission set.
kubernetesPermissionsobjectOptional
Defines the Kubernetes cluster permissions associated with this role.
deprecatedbooleanOptional
Indicates whether the role is deprecated. When set to true, the role is considered deprecated and should not be used for new assignments.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error