Internal Users

Get an internal user

GET/internal-users/{id}
internal-users:readget_internal_userRead-only

Returns one internal user with its lowercase status. include embeds groups, roles or invites. An unknown user, one outside the token's organisation, or one that is not an internal user returns 404. 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.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • includestring#

    Comma-separated related records to embed, from the operation's allowed list.

Responses

200

The internal user.

InternalUser
{
  "data": {
    "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "first_name": "Iris",
    "last_name": "Stone",
    "title": "Ms",
    "email": "iris.stone@example.com",
    "status": "active",
    "external_id": "HR-1042",
    "sso_id": null,
    "invite": null,
    "two_factor_enabled": true,
    "last_login": "2026-06-16T09:12:00Z",
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-18T16:20:00Z"
  }
}
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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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