Services
RPC methods exposed by this API.RoleService
| Method | Request | Response | Description |
|---|---|---|---|
| ListRoles | ListRolesRequest | ListRolesResponse |
Messages
Data models used across requests/responses.ListRolesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of roles to return. The service may return fewer than this value. If unspecified, at most 50 roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListRoles call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRoles must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are role_id, name, and description. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| order_by | string | How to order the retrieved channels. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are name and description. If left empty, items are ordered by name in ascending order (oldest-first). For more information about the format of this field, read this Example: “name desc,description” |
ListRolesResponse
| Field | Type | Label | Description |
|---|---|---|---|
| roles | Role | repeated | |
| next_page_token | string |
Role
| Field | Type | Label | Description |
|---|---|---|---|
| role_id | string | ||
| name | string | ||
| description | string | ||
| role_order | int32 |