Files
coder/docs/reference/cli/users.md
Edward Angert f9817af11f docs: add section on how to retrieve user list (#17798)
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>
2025-05-13 20:48:16 +00:00

1.4 KiB
Generated

users

Manage users

Aliases:

  • user

Usage

coder users [subcommand]

Subcommands

Name Purpose
create Create a new user.
list Prints the list of users.
show Show a single user. Use 'me' to indicate the currently authenticated user.
delete Delete a user by username or user_id.
edit-roles Edit a user's roles by username or id
activate Update a user's status to 'active'. Active users can fully interact with the platform
suspend Update a user's status to 'suspended'. A suspended user cannot log into the platform