Roles
Get Predefined Roles
Retrieves the predefined, or system managed, roles.
get/v3/roles
Response
The predefined, or system managed, roles.
Example response
{
"control_planes": {
"roles": {
"admin": {
"description": "This role grants full write access to all entities within a control plane."
},
"certificate_admin": {
"description": "This role grants full write access to administer certificates."
},
"consumer_admin": {
"description": "This role grants full write access to administer consumers."
},
"creator": {
"description": "Creates a new Control Plane in an organization. The creator becomes the owner of the Control Plane they create."
},
"debug_session_creator": {
"description": "This role grants access to create debug sessions. This role also grants read-only access to all entities within a control plane."
},
"deployer": {
"description": "This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub."
},
"gateway_service_admin": {
"description": "This role grants full write access to administer gateway services."
},
"plugin_admin": {
"description": "This role grants full write access to administer plugins."
},
"route_admin": {
"description": "This role grants full write access to administer routes."
},
"sni_admin": {
"description": "This role grants full write access to administer SNIs."
},
"upstream_admin": {
"description": "This role grants full write access to administer upstreams."
},
"viewer": {
"description": "This role grants read only access to all entities within a control plane."
}
}
},
"api_products": {
"roles": {
"admin": {
"description": "This role grants full write access to an API product and its versions."
},
"application_registration": {
"description": "This role grants permission to enable and disable application registration on an API product."
},
"creator": {
"description": "This access is required to create API products. This access is not for creating sub-entities such as versions, API specs, etc."
},
"deployer": {
"description": "This role grants permission to deploy and remove an API product from a control plane."
},
"maintainer": {
"description": "This role grants all write permission to manage an API product and to administer plugins."
},
"plugins_admin": {
"description": "This role grants full write permission to administer plugins."
},
"publisher": {
"description": "This role grants permission to publish an API product to one or more portals."
},
"viewer": {
"description": "Viewer has read-only access to an API product and its sub-entities."
}
}
},
"audit_logs": {
"roles": {
"admin": {
"description": "This role grants full write access to the Audit log configuration."
}
}
},
"identity": {
"roles": {
"admin": {
"description": "This role grants full write access to the Identity configuration."
}
}
},
"mesh_control_planes": {
"roles": {
"admin": {
"description": "This role grants full write access to the related to Mesh control planes."
},
"connector": {
"description": "This role grants a mesh zone to connect to the mesh control plane in Konnect."
},
"creator": {
"description": "This role grants access to create new Mesh control planes."
},
"viewer": {
"description": "This role grants access to read-only permissions to Mesh control planes."
}
}
},
"dashboards": {
"roles": {
"admin": {
"description": "Allows users to edit, delete, and share a Dashboard in Konnect Analytics."
},
"creator": {
"description": "Allows users to create a new Dashboard in Konnect Analytics."
},
"editor": {
"description": "Allows users to edit a Dashboard in Konnect Analytics."
},
"viewer": {
"description": "Allows users to view any Dashboards content in Konnect Analytics."
}
}
},
"reports": {
"roles": {
"admin": {
"description": "Allows users to edit, delete, and share a Report in Konnect Analytics."
},
"creator": {
"description": "Allows users to create a new Report in Konnect Analytics."
},
"editor": {
"description": "Allows users to edit a Report in Konnect Analytics."
},
"viewer": {
"description": "Allows users to view a Report in Konnect Analytics."
}
}
}
}