Roles

Returns the assigned role for the specified ID.

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

Request

  • Base URL
    https://global.api.konghq.com
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Response

A get action response of a single assigned role.

idstring uuid

The ID of the role assignment.

role_namestring

Name of the role being assigned.

entity_idstring uuid

A RBAC entity ID. Deprecated in favor of entity_ids

entity_idsstring[]

The IDs of the entities associated with this role assignment. Mutually exclusive with entity_id; exactly one of entity_id or entity_ids must be provided.

entity_type_namestring

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

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

Region of the entity.

konnect_managedboolean

Pre-release Feature This feature is currently in beta and is subject to change.

Indicates that the role is assigned and removed only by Konnect.

Example response

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

Changes