mirror of https://github.com/coder/coder.git synced 2025-07-06 15:41:45 +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

1.3 KiB

Generated

Raw Blame History

users create

Create a new user.

Usage

coder users create [flags]

Options

-e, --email


Type	`string`

Specifies an email address for the new user.

-u, --username


Type	`string`

Specifies a username for the new user.

-n, --full-name


Type	`string`

Specifies an optional human-readable name for the new user.

-p, --password


Type	`string`

Specifies a password for the new user.


Type	`string`

Optionally specify the login type for the user. Valid values are: password, none, github, oidc. Using 'none' prevents the user from authenticating and requires an API key/token to be generated by an admin.

-O, --org


Type	`string`
Environment	`$CODER_ORGANIZATION`

Select which organization (uuid or name) to use.

1.3 KiB Generated Raw Blame History