Assign Team Role
Assigns a role to a team. Returns 409 if role is already assigned.
Path Parameters
The team ID
Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe
Body
application/json
Body
The request schema for assigning a role.
An assigned role is a role that has been assigned to a user or team.
The desired role.
Allowed values:AdminAppearance MaintainerApplication RegistrationCertificate AdminCloud Gateway Cluster AdminCloud Gateway Cluster ViewerConsumer AdminConnectorCreatorDebug Session CreatorDeployerDiscovery AdminDiscovery ViewerEditorGateway Service AdminIntegration AdminIntegration ViewerKey AdminMaintainerNetwork AdminNetwork CreatorNetwork ViewerPlugin AdminPlugins AdminProduct PublisherPublisherRoute AdminSNI AdminScorecard AdminScorecard ViewerService AdminService CreatorService ViewerUpstream AdminVault AdminViewerRegistration ApproverContent Editor
Example:Viewer
The ID of the entity.
Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a
The type of entity.
Allowed values:APIsAPI ProductsApplication Auth StrategiesAudit LogsControl PlanesDashboardsDCR ProvidersIdentityMesh Control PlanesNetworksPortalsReportsService Hub
Example:Control Planes
Region of the team.
Allowed values:useuaumeinsg*
Example:eu
Response
application/json
Response
A get action response of a single assigned role.
AssignedRole
An assigned role is a role that has been assigned to a user or team.
The ID of the role assignment.
Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67
Name of the role being assigned.
Example:Viewer
A RBAC entity ID.
Example:817d0422-45c9-4d88-8d64-45aef05c1ae7
Name of the entity type the role is being assigned to.
Example:Control Planes
Region of the entity.
Allowed values:useuaumeinsg*
Example:eu
Authentication
Path Parameters
Body
Get Team Role
Returns the assigned role for the specified ID.
Path Parameters
The team ID.
Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe
The role ID.
Example:8350205f-a305-4e39-abe9-bc082a80091a
Response
application/json
Response
A get action response of a single assigned role.
AssignedRole
An assigned role is a role that has been assigned to a user or team.
The ID of the role assignment.
Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67
Name of the role being assigned.
Example:Viewer
A RBAC entity ID.
Example:817d0422-45c9-4d88-8d64-45aef05c1ae7
Name of the entity type the role is being assigned to.
Example:Control Planes
Region of the entity.
Allowed values:useuaumeinsg*
Example:eu
Authentication
Path Parameters
Remove Team Role
Removes an assigned role from a team. Returns 404 if the requested team or assigned role were not found.
Path Parameters
The team ID.
Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe
The role ID.
Example:8350205f-a305-4e39-abe9-bc082a80091a
Response
Response
No Content
Authentication
Path Parameters
List User Roles
Lists the roles assigned to a user. Returns 400 if any filter parameters are invalid.
Query Parameters
Filter roles returned in the response.
Show Child Parameters
Path Parameters
The user ID
Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe
Response
application/json
Response
A paginated list response for a collection of assigned roles.
Assigned Role Collection Response
returns the pagination information
Show Child Parameters
An assigned role is a role that has been assigned to a user or team.
Example:{"id":"54cc6168-ebb1-4300-8168-d62a0dd08fc8","role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Control Planes","entity_region":"us"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Assign Role
Assigns a role to a user. Returns 409 if role is already assigned.
Path Parameters
The user ID
Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe
Body
application/json
Body
The request schema for assigning a role.
An assigned role is a role that has been assigned to a user or team.
The desired role.
Allowed values:AdminAppearance MaintainerApplication RegistrationCertificate AdminCloud Gateway Cluster AdminCloud Gateway Cluster ViewerConsumer AdminConnectorCreatorDebug Session CreatorDeployerDiscovery AdminDiscovery ViewerEditorGateway Service AdminIntegration AdminIntegration ViewerKey AdminMaintainerNetwork AdminNetwork CreatorNetwork ViewerPlugin AdminPlugins AdminProduct PublisherPublisherRoute AdminSNI AdminScorecard AdminScorecard ViewerService AdminService CreatorService ViewerUpstream AdminVault AdminViewerRegistration ApproverContent Editor
Example:Viewer
The ID of the entity.
Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a
The type of entity.
Allowed values:APIsAPI ProductsApplication Auth StrategiesAudit LogsControl PlanesDashboardsDCR ProvidersIdentityMesh Control PlanesNetworksPortalsReportsService Hub
Example:Control Planes
Region of the team.
Allowed values:useuaumeinsg*
Example:eu
Response
application/json
Response
A get action response of a single assigned role.
AssignedRole
An assigned role is a role that has been assigned to a user or team.
The ID of the role assignment.
Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67
Name of the role being assigned.
Example:Viewer
A RBAC entity ID.
Example:817d0422-45c9-4d88-8d64-45aef05c1ae7
Name of the entity type the role is being assigned to.
Example:Control Planes
Region of the entity.
Allowed values:useuaumeinsg*
Example:eu