List Consumer Roles
Endpoint
GET /apiops/projects/{projectName}/consumer-roles
Authentication
Requires a Personal API Access Token.
Authorization: Bearer YOUR_TOKEN
Request
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| projectName | string | Yes | Project name |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | No | Case-insensitive contains-match on the name |
| page | integer | No | Zero-based page index. Default 0 |
| size | integer | No | Rows per page. Default 20, capped at 200 |
| sort | string | No | name,asc or name,desc. Default name,asc |
Response
200 OK with the paged envelope. Each item is a role:
| Field | Type | Description |
|---|---|---|
| name | string | Name of the role |
| oauthScope | string | OAuth scope name that the role answers to. Absent when the role has none |
cURL Example
curl -X GET \
"https://demo.apinizer.com/apiops/projects/MyProject/consumer-roles?search=admin" \
-H "Authorization: Bearer YOUR_TOKEN"
Permissions
- User must have
IDENTITY+VIEWpermission in the project - A project outside the scope of the caller answers
404 resourceNotFound, never403 - The admin project is served: a call on
/apiops/projects/admin/consumer-rolesaddresses the roles of the admin project