> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.

# roles

> sift/roles/v2/roles.proto

<a name="sift_roles_v2_roles-proto" />

<a name="sift_roles_v2_roles-proto-services" />

## Services

*RPC methods exposed by this API.*

### RoleService

| Method    | Request                               | Response                                | Description |
| :-------- | :------------------------------------ | :-------------------------------------- | :---------- |
| ListRoles | [ListRolesRequest](#listrolesrequest) | [ListRolesResponse](#listrolesresponse) |             |

<a name="sift_roles_v2_roles-proto-messages" />

## 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)](https://github.com/google/cel-spec) 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](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/channels#channel). 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](https://google.aip.dev/132#ordering) Example: "name desc,description"                                                                                               |

### ListRolesResponse

| Field             | Type          | Label    | Description |
| :---------------- | :------------ | :------- | :---------- |
| roles             | [Role](#role) | repeated |             |
| next\_page\_token | string        |          |             |

### Role

| Field       | Type   | Label | Description |
| :---------- | :----- | :---- | :---------- |
| role\_id    | string |       |             |
| name        | string |       |             |
| description | string |       |             |
| role\_order | int32  |       |             |

<a name="sift_roles_v2_roles-proto-enums" />

## Enums

*Allowed constant values used in message fields.*