System Accounts - Roles

List Assigned Roles for System Account

Lists the roles belonging to a system account. Returns 400 if any filter parameters are invalid.

get
https://global.api.konghq.com/v3/system-accounts/{accountId}/assigned-roles

Query Parameters

filterobject

Filter roles returned in the response.

Show Child Parameters

Path Parameters

accountIdstringrequired

ID of the system account.

Response

application/json

A paginated list response for a collection of assigned roles.

Assigned Role Collection Response

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

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
get/system-accounts/{accountId}/assigned-roles
 
application/json

Create Assigned Role for System Account

Assigns a role to a system account. Returns 409 if role is already assigned.

post
https://global.api.konghq.com/v3/system-accounts/{accountId}/assigned-roles

Path Parameters

accountIdstringrequired

ID of the system account.

Body

application/json

The request schema for assigning a role.

An assigned role is a role that has been assigned to a user or team.

role_namestring

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

entity_idstring(uuid)

The ID of the entity.

Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a

entity_type_namestring

The type of entity.

Allowed values:APIsAPI ProductsApplication Auth StrategiesAudit LogsControl PlanesDashboardsDCR ProvidersIdentityMesh Control PlanesNetworksPortalsReportsService Hub

Example:Control Planes

entity_regionstring

Region of the team.

Allowed values:useuaumeinsg*

Example:eu

Response

application/json

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.

idstring(uuid)

The ID of the role assignment.

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestring

Name of the role being assigned.

Example:Viewer

entity_idstring(uuid)

A RBAC entity ID.

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestring

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

Example:Control Planes

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

post/system-accounts/{accountId}/assigned-roles

Body

{ "role_name": "Viewer", "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61", "entity_type_name": "Control Planes", "entity_region": "us" }
 
application/json

Get System Account Role

Returns the assigned role for the specified ID.

get
https://global.api.konghq.com/v3/system-accounts/{accountId}/assigned-roles/{roleId}

Path Parameters

accountIdstringrequired

ID of the system account.

roleIdstringrequired

ID of the role.

Response

application/json

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.

idstring(uuid)

The ID of the role assignment.

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestring

Name of the role being assigned.

Example:Viewer

entity_idstring(uuid)

A RBAC entity ID.

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestring

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

Example:Control Planes

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

get/system-accounts/{accountId}/assigned-roles/{roleId}
 
application/json

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.

delete
https://global.api.konghq.com/v3/system-accounts/{accountId}/assigned-roles/{roleId}

Path Parameters

accountIdstringrequired

ID of the system account.

roleIdstringrequired

ID of the role.

Response

No Content

delete/system-accounts/{accountId}/assigned-roles/{roleId}