TeamGroupMapping

object

A map of Konnect Team to IdP groups.

team_idstring(uuid)

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupsarray[string]unique-items

The IdP groups that are mapped to the specified team.

Example:API Engineers

Example

AssignedRole

object

An assigned role is a role that has been assigned to a user or team.

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:Runtime Groups

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

Example

System Account

object

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

Example

System Account Access Token

object

Schema of the system account access token.

idstring(uuid)read-only

ID of the system account access token.

namestring

Name of the system account access token.

created_atstring(date-time)read-only

Timestamp of when the system account access token was created.

updated_atstring(date-time)read-only

Timestamp of when the system account access token was last updated.

expires_atstring(date-time)

Timestamp of when the system account access token will expire.

last_used_atstring(date-time)read-only

Timestamp of when the system account access token was last used.

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