Dan HeathandRobin Beck
5ce6515156
* docs: IA reorganization * docs: Updates * docs: Updates * docs: Fix links * docs: Updates * docs: Fix a typo * docs: Fix client agent topic * docs: Update Client Agent nav * docs: Fix conflict * docs: Fix a typo in Client Agent docs (#5853) * docs: Fix client agent topic * docs: Updates * docs: Updates * docs: Updates * docs: Updates * docs: Fixes get started and operations links * docs: Update nav * docs: Partials * docs: Unix partials * docs: Worker partials * docs: Updates * docs: Update workers and targets * docs: Updates * docs: Updates * docs: Fixes link * docs: Updates after sync review * docs: Updates from review feedback * docs: Move worker filter examples * docs: Fix links * docs: Updates for filters based on working session * docs: Fixes broken links * docs: Add links to other filter topics * docs: Update list intro * docs: Adds link * docs: Fixes redirects * docs: Fixes redirects * docs: Deleted mysql page from TOC * docs: Add versioned redirect * docs: Adds versioned redirects * docs: Adds versioned redirects * docs: Update redirects * docs: Update redirects * docs: Redirect fixes * docs: Update redirect format * docs: Fix a typo * docs: Fixes redirects * docs: Fixes redirect * docs: Adds links out to client agent troubleshooting * uses /etc/boundary.d/ as recommended installation directory (#6003) * docs: Updates legacy io links * docs: Fixes redirects * docs: Fix redirect * docs: Restoring deleted file --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
50 lines
1.8 KiB
Plaintext
50 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: users list - Command
|
|
description: >-
|
|
The "users list" command lists the available user resources from the specified scope or resource.
|
|
---
|
|
|
|
# users list
|
|
|
|
Command: `users list`
|
|
|
|
The `users list` command lets you list the users who belong to a given scope or resource.
|
|
|
|
## Example
|
|
|
|
This example lists all users in the scope `s_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary users list -scope-id s_1234567890
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary users list [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-filter=<string>` - If set, Boundary filters the list operation before it is returned.
|
|
The filter operates against each item in the list.
|
|
We recommend that you use single quotes, as filters contain double quotes.
|
|
Refer to the [Filtering and listing resources documentation](/boundary/docs/filtering) for more details.
|
|
- `-recursive` - If set, runs the list operation recursively into child scopes, if the type supports it.
|
|
The default value is `false`.
|
|
- `-scope-id=<string>` - The scope that contains the users you want to list.
|
|
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' |