PortalTeamResponse

object

Details about a developer team.

idstring(uuid)read-only

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

namestring

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

<= 250 characters

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The developers for the IDM API.

created_atstring(date-time)read-only

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

updated_atstring(date-time)read-only

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

Example

PortalTeamGroupMappingResponse

object

A paginated list of portal team group mappings.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

A map of portal teams to Identity Provider groups.

Example:{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]}

Show Child Parameters
Example

PortalTeamGroupMapping

object

A map of portal teams to Identity Provider 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

PortalAssignedRoleResponse

object

An assigned role associates a service and an action to a team.

idstring(uuid)required

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

role_namestringrequired

Example:API Viewer

entity_idstring(uuid)required

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

entity_type_namestringrequired

Example:Services

entity_regionstringrequired

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

Example

ListPortalsResponse

object

A paginated list of portals in the current region in the organization.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Example:{"id":"9f9fd312-a987-4628-b4c5-bb4f4fddd5f7","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z","name":"Portal A","display_name":"Developer Portal A","description":"The Portal A","default_domain":"123455678abcd.us.portal.konghq.com","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":true,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","application_count":0,"developer_count":0,"published_product_count":0}

* Additional properties are NOT allowed.
Show Child Parameters
Example