User

object

The user object contains information about an individual user who can use the Konnect application and API.

idstring(uuid)read-only

The User ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

emailstring(email)

The email registered to the user.

<= 250 characters

Example:user@email.com

full_namestring

The User’s full name.

Match pattern:^[\w \W]+$

<= 250 characters

Example:Jane Doe

preferred_namestring

The User’s preferred name.

<= 250 characters

Example:Jane

activebooleanread-only

Returns True if a user has verified their email address.

Default:true

inferred_regionstringread-only

The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.

Example:us

created_atstring(date-time)read-only

The time stamp for the date the account was registered.

Example:2022-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

A Unix timestamp representation of the most recent change to the User account.

Example:2022-10-08T17:00:00.52Z

Example

ParameterizedAssignedRole

object

A parameterized assigned role is a role that has been assigned to a managed system account with additional parameters.

idstring(uuid)

The ID of the role assignment.

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestring

Name of the role being assigned.

Example:Viewer

entity_idstring(uuid)

A RBAC entity ID.

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestring

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

Example:Control Planes

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

parametersobject

Additional parameters for the role assignment.

* Additional properties are allowed.
Example

User with Organization IDs only.

object

User with Organization IDs only.

idstring(uuid)read-only

ID of a user.

organization_idstring(uuid)read-only

organization ID of a user.

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

InvalidRules

string

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype