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>
This commit is contained in:
Edward Angert
2025-05-13 20:48:16 +00:00
committed by GitHub
co-authored by EdwardAngert M Atif Ali
parent 170f41ac55
commit f9817af11f
10 changed files with 56 additions and 5 deletions
+2 -2
View File
@@ -10,10 +10,10 @@ USAGE:
SUBCOMMANDS:
activate Update a user's status to 'active'. Active users can fully
interact with the platform
create
create Create a new user.
delete Delete a user by username or user_id.
edit-roles Edit a user's roles by username or id
list
list Prints the list of users.
show Show a single user. Use 'me' to indicate the currently
authenticated user.
suspend Update a user's status to 'suspended'. A suspended user cannot
+2
View File
@@ -3,6 +3,8 @@ coder v0.0.0-devel
USAGE:
coder users create [flags]
Create a new user.
OPTIONS:
-O, --org string, $CODER_ORGANIZATION
Select which organization (uuid or name) to use.
+2
View File
@@ -3,6 +3,8 @@ coder v0.0.0-devel
USAGE:
coder users list [flags]
Prints the list of users.
Aliases: ls
OPTIONS: