Team

object

The team object contains information about a group of users.

idstring(uuid)read-only

The team ID.

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

namestring

The name of the team.

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

<= 250 characters

Example:IDM - Developers

descriptionstring

The team description in Konnect.

<= 250 characters

Example:The developers for the IDM API.

system_teambooleanread-only

Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like “Organization Admin”, or “Service”

Default:false

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)read-only

A Unix timestamp representation of team creation.

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

updated_atstring(date-time)read-only

A Unix timestamp representation of the most recent change to the team object in Konnect.

Example:2022-02-07T17:00:00.52Z

Example

TeamMapping

object

A team assignment is a mapping of an IdP group to a Konnect Team.

groupstring

The IdP group.

Example:Service Developers

team_idsarray[string](uuid)unique-items

An array of ID’s that are mapped to the specified group.

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

Example

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:Control Planes

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