mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
f9817af11f
previews - [admin/users](https://coder.com/docs/@export-coder-users/admin/users) - [reference/cli/users](https://coder.com/docs/@export-coder-users/reference/cli/users) followup to slack thread: > Tim > what's the best way for customers to export a list of Coder users? > > @ericpaulsen > the `/api/v2/users` API route returns all users in the deployment (along with other information - email, status, username, etc.). from <https://coder.com/docs/reference/api/users#get-users> - adds an easy-to-find section to the admin/users doc - updates the cli commands with short descriptions --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: M Atif Ali <atif@coder.com>
43 lines
877 B
Markdown
Generated
43 lines
877 B
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
# users list
|
|
|
|
Prints the list of users.
|
|
|
|
Aliases:
|
|
|
|
* ls
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder users list [flags]
|
|
```
|
|
|
|
## Options
|
|
|
|
### --github-user-id
|
|
|
|
| | |
|
|
|------|------------------|
|
|
| Type | <code>int</code> |
|
|
|
|
Filter users by their GitHub user ID.
|
|
|
|
### -c, --column
|
|
|
|
| | |
|
|
|---------|--------------------------------------------------------------------|
|
|
| Type | <code>[id\|username\|email\|created at\|updated at\|status]</code> |
|
|
| Default | <code>username,email,created at,status</code> |
|
|
|
|
Columns to display in table output.
|
|
|
|
### -o, --output
|
|
|
|
| | |
|
|
|---------|--------------------------|
|
|
| Type | <code>table\|json</code> |
|
|
| Default | <code>table</code> |
|
|
|
|
Output format.
|