Portal Team Roles

Assign Role

Changed on

Assign a role to a developer team. This associates the set of permissions in a role with the team, so that they will be applied to any developer who is a member of the team.

post/v3/portals/{portalId}/teams/{teamId}/assigned-roles

Request

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

Request body

role_namestring required
entity_idstring uuid required
entity_type_namestring required
entity_region'us' | 'eu' | 'au' | 'me' | 'in' | 'sg' | '*' required

Region of the entity.

Example request

{
  "role_name": "API Viewer",
  "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  "entity_type_name": "Services",
  "entity_region": "us"
}

Response

Details about the role assignment.

idstring uuid required
role_namestring required
entity_idstring uuid required
entity_type_namestring required
entity_region'us' | 'eu' | 'au' | 'me' | 'in' | 'sg' | '*' required

Region of the entity.

Example response

{
  "id": "1a3c2169-27f8-4594-926b-41df3432d5dc",
  "role_name": "API Viewer",
  "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  "entity_type_name": "Services",
  "entity_region": "us"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

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

    • 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

    • warning

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