Portal Teams

Update Team

Changed on

Updates an individual developer team for a portal.

patch/v3/portals/{portalId}/teams/{teamId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/teams/{teamId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring

The name of the team.

descriptionstring

The description of the team.

can_own_applicationsboolean

Whether the team is allowed to own applications.

konnect_managedboolean

Whether the team's membership is managed by Konnect instead of being synced from an identity provider's team mappings. Set to false (default) to let identity provider team mappings keep syncing members into this team. Set to true to manage membership directly in Konnect and prevent identity provider team mappings from syncing to this team.

Example request

{
  "name": "IDM - Developers",
  "description": "The Identity Management (IDM) API team.",
  "can_own_applications": false,
  "konnect_managed": false
}

Response

Details about a team of developers in a portal.

idstring uuid required
namestring required

The name of the team.

descriptionstring required

The description of the team.

created_atstring date-time required
updated_atstring date-time required
can_own_applicationsboolean

Whether the team is allowed to own applications.

konnect_managedboolean

Whether the team's membership is managed by Konnect instead of being synced from an identity provider's team mappings. Set to false (default) to let identity provider team mappings keep syncing members into this team. Set to true to manage membership directly in Konnect and prevent identity provider team mappings from syncing to this team.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "name": "IDM - Developers",
  "description": "The developers for the IDM API.",
  "created_at": "1992-02-07T17:46:57.52Z",
  "updated_at": "2022-08-31T17:00:00.52Z",
  "can_own_applications": false,
  "konnect_managed": false
}

Changes

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

  • 1fe64030316bRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status