Sign in
Roles

Assign Team Role

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

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

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 nullable

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 nullable

Name of the role being assigned.

entity_idstring uuid nullable

A RBAC entity ID.

entity_type_namestring nullable

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

Changed in 16 of the 52 revisions of this API.221433

  • 421937fd1ff511See the full diff
    • ▲

      removed the enum value Identity of the request property

      request-property-enum-value-removed

    • ○

      added the new Auth Servers enum value to the request property

      request-property-enum-value-added

  • 1f9c36d98f8d3See the full diff
    • ○

      added the new Add On Admin enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Add On Viewer enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Add Ons enum value to the request property

      request-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • aad4daa45eee1See the full diff
    • ○

      added the new Debug Session Creator enum value to the request property

      request-property-enum-value-added

  • 2eb528e691a22See the full diff
    • ○

      added the new Content Editor enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Registration Approver enum value to the request property

      request-property-enum-value-added

  • 2b2a72c67bd22See the full diff
    • ○

      added the new Editor enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Reports enum value to the request property

      request-property-enum-value-added

  • 19e869275e281See the full diff
    • ●

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

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f0305901662211See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the new sg enum value to the request property

      request-property-enum-value-added

  • 96118a9cd7f481See the full diff
    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9ca62eba4eca1See the full diff
    • ○

      added the new Dashboards enum value to the request property

      request-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c308b7426a7c2See the full diff
    • ○

      added the new Scorecard Admin enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Scorecard Viewer enum value to the request property

      request-property-enum-value-added