Dan HeathandRobin Beck
b442c1fa60
* docs: Update meta content - CLI * docs: Edits for consistency * docs: More edits for consistency * Apply batch of suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Apply batch suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Remove given id references * Update read.mdx * Update read.mdx --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
51 lines
2.0 KiB
Plaintext
51 lines
2.0 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: roles list - Command
|
|
description: >-
|
|
The "roles list" command lists the available role resources within a scope or resource.
|
|
---
|
|
|
|
# roles list
|
|
|
|
Command: `boundary roles list`
|
|
|
|
The `boundary roles list` command lets you list the Boundary roles within a given scope or resource.
|
|
|
|
## Example
|
|
|
|
This example lists all roles within the scope `s_1234567890`.
|
|
The `recursive` option means Boundary runs the operation recursively on any child scopes, if applicable:
|
|
|
|
```shell-session
|
|
$ boundary roles list -scope-id s_1234567890 -recursive
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary roles list [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-filter=<string>` - If set, filters the list operation before the results are returned.
|
|
The filter operates against each item in the list.
|
|
We recommend that you use single quotes, because the filters contain double quotes.
|
|
Refer to the [Filter resource listings documentation](/boundary/docs/concepts/filtering/resource-listing) for more details.
|
|
- `-recursive` - If set, runs the list operation recursively on any child scopes, if the type supports it.
|
|
The default value is `false`.
|
|
- `-scope-id=<string>` - The enclosing scope from which you want to list the roles.
|
|
The default value is `global`.
|
|
You can also specify this value using the **BOUNDARY_SCOPE_ID** environment variable.
|
|
- `list_token` (optional) - An opaque token that is returned from the previous `list` response.
|
|
If you do not supply a value, pagination starts from the beginning.
|
|
- `page_size` (optional) - An unsigned integer that indicates the number of items that should be included on the page of search results.
|
|
If you do not provide a value, or if you provide a value of `0`, Boundary uses the default page size of 1000 items.
|
|
If you configure it, the `page_size` value overrides the default page size.
|
|
Controller administrators can also configure a `max_page_size` option that constrains the maximum page size a user can request.
|
|
|
|
@include 'cmd-option-note.mdx' |