Sign in
Roles

Get User Role

Returns the assigned role for the specified ID.

get/v3/users/{userId}/assigned-roles/{roleId}

Response

A get action response of a single assigned role.

idstring uuid

The ID of the role assignment.

role_namestring nullable

Name of the role being assigned.

entity_idstring uuid nullable

A RBAC entity ID.

entity_type_namestring nullable

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

entity_region'us' | 'eu' | 'au' | 'me' | 'in' | 'sg' | '*'

Region of the entity.

Example response

{
  "id": "54cc6168-ebb1-4300-8168-d62a0dd08fc8",
  "role_name": "Viewer",
  "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  "entity_type_name": "Control Planes",
  "entity_region": "us"
}

Changes

Changed in 1 of the 52 revisions of this API.1