Create Assigned Role for System Account
Assigns a role to a system account. Returns 409 if role is already assigned.
Path Parameters
ID of the system account.
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 System Account Role
Returns the assigned role for the specified ID.
Path Parameters
ID of the system account.
ID of the role.
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
Delete Assigned Role from System Account
Removes an assigned role from a system account. Returns 404 if the system account or assigned role were not found.
Path Parameters
ID of the system account.
ID of the role.
Response
Response
No Content
Authentication
Path Parameters
System Accounts - Team Membership
List System Accounts on a Team
Returns a paginated list of system accounts that belong to the team specified in the path parameter.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter system accounts returned in the response.
Show Child Parameters
Path Parameters
ID of the team.
Response
application/json
Response
A paginated list response for a collection of system accounts.
System Account Collection Response
returns the pagination information
Show Child Parameters
Schema of the system account.
Example:{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Example System Account","description":"This is a sample system account description.","created_at":"2022-08-24T14:15:22Z","updated_at":"2022-10-05T10:33:49Z","konnect_managed":false}