User

object

The user’s full profile

idstringrequiredread-only

Unique identifier for the user

Example:usr_abc123

first_namestringrequired

The user’s first name

Example:Jane

last_namestringrequired

The user’s last name

Example:Doe

picturestring(uri)

URL to the user’s profile picture

Example:https://cdn.insomnia.rest/avatars/usr_abc123.jpg

emailstring(email)required

The email address

Example:jane.doe@example.com

emailsarray[object]requiredread-only

An email address associated with a user

Show Child Parameters
is_externally_provisionedbooleanrequiredread-only

Indicates the user was provisioned externally (e.g., via SCIM). When true, profile fields (first_name, last_name, email, emails, picture) cannot be updated by the user.

encryption_enabledbooleanrequiredread-only

Whether end-to-end encryption is enabled for this user

created_atstring(date-time)requiredread-only

The date and time the user account was created

Example:2024-01-15T08:30:00Z

Example

UserEmail

object

An email address associated with a user

emailstring(email)required

The email address

Example:jane.doe@example.com

is_primarybooleanrequired

Whether this is the user’s primary email

Example:true

Example

UserEncryptionKeys

object

The user’s encryption keys for end-to-end encryption

public_keystringrequiredread-only

The user’s public key

enc_private_keystringrequiredread-only

The user’s encrypted private key

enc_symmetric_keystringrequiredread-only

The user’s encrypted symmetric key

salt_encstringrequiredread-only

Salt used for encryption key derivation

enc_driver_keystringrequiredread-only

The user’s encrypted driver key

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example

UnauthorizedError

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

Example:401

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

Example:Unauthorized

typestringread-only

The error type.

Example:https://httpstatuses.com/401

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

Example:kong:trace:1234567890

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example:Invalid credentials

Example