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>
27 lines
1.4 KiB
Markdown
Generated
27 lines
1.4 KiB
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
# users
|
|
|
|
Manage users
|
|
|
|
Aliases:
|
|
|
|
* user
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder users [subcommand]
|
|
```
|
|
|
|
## Subcommands
|
|
|
|
| Name | Purpose |
|
|
|--------------------------------------------------|---------------------------------------------------------------------------------------|
|
|
| [<code>create</code>](./users_create.md) | Create a new user. |
|
|
| [<code>list</code>](./users_list.md) | Prints the list of users. |
|
|
| [<code>show</code>](./users_show.md) | Show a single user. Use 'me' to indicate the currently authenticated user. |
|
|
| [<code>delete</code>](./users_delete.md) | Delete a user by username or user_id. |
|
|
| [<code>edit-roles</code>](./users_edit-roles.md) | Edit a user's roles by username or id |
|
|
| [<code>activate</code>](./users_activate.md) | Update a user's status to 'active'. Active users can fully interact with the platform |
|
|
| [<code>suspend</code>](./users_suspend.md) | Update a user's status to 'suspended'. A suspended user cannot log into the platform |
|