mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00

Files

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

877 B

Generated

Raw Blame History

users list

Prints the list of users.

Aliases:

Usage

coder users list [flags]

Options

--github-user-id


Type	`int`

Filter users by their GitHub user ID.

-c, --column


Type	`[id\|username\|email\|created at\|updated at\|status]`
Default	`username,email,created at,status`

Columns to display in table output.

-o, --output


Type	`table\|json`
Default	`table`

Output format.

877 B Generated Raw Blame History