Internal Users

List the roles an internal user holds

GET/internal-users/{id}/roles
internal-users:readread_internal_user_rolesRead-only

Returns every role the internal user holds, each with id, name and label. An unknown internal user returns 404. The add and replace calls return the same set. Sends nothing.

Path parameters

  • idstring (uuid)Required#

    The internal user's id, a uuid. An unknown user, or one outside the token's organisation, returns 404.

Responses

200

Every role the internal user holds.

InternalUserRole[]
{
  "data": [
    {
      "id": 7,
      "name": "admin",
      "label": "Administrator"
    },
    {
      "id": 12,
      "name": "compliance",
      "label": "Compliance Officer"
    }
  ]
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/internal-users/{id}/roles\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"