Sign in
Roles

Assign Role

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

post/v3/users/{userId}/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

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

Changed in 12 of the 75 revisions of this API.22928

  • ccc33535acb511See 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

  • f48a778e1edc3See 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

  • 6dabb1df19ab1See the full diff
    • ○

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

      request-property-enum-value-added

  • 69f1a71241652See 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

  • b9b4ba83d16d2See 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

  • 845120e19d451See the full diff
    • ▲

      the request property became not nullable

      request-property-became-not-nullable

  • 8ab3ec3ed3011See the full diff
    • ●

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

      response-property-enum-value-added

  • ddf026fbd25b11See 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

  • 3c0154b2053a81See 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 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6333a0d3b095378See the full diff
    • ▲

      request property was restricted to a list of enum values

      request-property-became-enum

    • ▲

      the request property type changed from no type to string

      request-property-type-changed

    • ▲

      the response's property type changed from no type to string for status

      response-property-type-changed

    • ●

      removed subschema #2 from the request property allOf list

      request-property-all-of-removed

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new * enum value to the request property

      request-property-enum-value-added

    • ○

      added the new Dashboards enum value to the request property

      request-property-enum-value-added

    • ○

      added the new au enum value to the request property

      request-property-enum-value-added

    • ○

      added the new eu enum value to the request property

      request-property-enum-value-added

    • ○

      added the new in enum value to the request property

      request-property-enum-value-added

    • ○

      added the new me enum value to the request property

      request-property-enum-value-added

    • ○

      added the new us enum value to the request property

      request-property-enum-value-added

    • ○

      removed subschema #2 from the response property allOf list for the response status

      response-property-all-of-removed

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