Roles

Get Team Role

Changed on

Returns the assigned role for the specified ID.

get/v3/teams/{teamId}/assigned-roles/{roleId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/teams/{teamId}/assigned-roles/{roleId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • 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.

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.

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

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status