Roles

Assign Team Role

Changed on

Assigns a role to a team. Returns 409 if role is already assigned.

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

Request

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

Request body

role_name'Admin' | 'Appearance Maintainer' | 'Application Registration' | 'Certificate Admin' | 'Cloud Gateway Cluster Admin' | 'Cloud Gateway Cluster Viewer' | 'Consumer Admin' | 'Connector' | 'Creator' | 'Debug Session Creator' | 'Deployer' | 'Discovery Admin' | 'Discovery Viewer' | 'Editor' | 'Gateway Service Admin' | 'Integration Admin' | 'Integration Viewer' | 'Key Admin' | 'Maintainer' | 'Network Admin' | 'Network Creator' | 'Network Viewer' | 'Plugin Admin' | 'Plugins Admin' | 'Product Publisher' | 'Publisher' | 'Route Admin' | 'SNI Admin' | 'Scorecard Admin' | 'Scorecard Viewer' | 'Service Admin' | 'Service Creator' | 'Service Viewer' | 'Upstream Admin' | 'Vault Admin' | 'Viewer' | 'Registration Approver' | 'Content Editor' | 'Add On Admin' | 'Add On Viewer'

The desired role.

entity_idstring uuid

The ID of the entity.

entity_type_name'Add Ons' | 'APIs' | 'API Products' | 'Application Auth Strategies' | 'Audit Logs' | 'Control Planes' | 'Dashboards' | 'DCR Providers' | 'Mesh Control Planes' | 'Networks' | 'Portals' | 'Reports' | 'Service Hub' | 'Auth Servers'

The type of entity.

entity_region'us' | 'eu' | 'au' | 'me' | 'in' | 'sg' | '*'

Region of the team.

Example request

{
  "role_name": "Viewer",
  "entity_id": "e67490ce-44dc-4cbd-b65e-b52c746fc26a",
  "entity_type_name": "Control Planes",
  "entity_region": "eu"
}

Response

A get action response of a single assigned role.

idstring uuid

The ID of the role assignment.

role_namestring

Name of the role being assigned.

entity_idstring uuid

A RBAC entity ID.

entity_type_namestring

Name of the entity type the role is being assigned to.

entity_region'us' | 'eu' | 'au' | 'me' | 'in' | 'sg' | '*'

Region of the entity.

Example response

{
  "id": "54cc6168-ebb1-4300-8168-d62a0dd08fc8",
  "role_name": "Viewer",
  "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  "entity_type_name": "Control Planes",
  "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 401.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