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>
62 lines
1.3 KiB
Markdown
Generated
62 lines
1.3 KiB
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
# users create
|
|
|
|
Create a new user.
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder users create [flags]
|
|
```
|
|
|
|
## Options
|
|
|
|
### -e, --email
|
|
|
|
| | |
|
|
|------|---------------------|
|
|
| Type | <code>string</code> |
|
|
|
|
Specifies an email address for the new user.
|
|
|
|
### -u, --username
|
|
|
|
| | |
|
|
|------|---------------------|
|
|
| Type | <code>string</code> |
|
|
|
|
Specifies a username for the new user.
|
|
|
|
### -n, --full-name
|
|
|
|
| | |
|
|
|------|---------------------|
|
|
| Type | <code>string</code> |
|
|
|
|
Specifies an optional human-readable name for the new user.
|
|
|
|
### -p, --password
|
|
|
|
| | |
|
|
|------|---------------------|
|
|
| Type | <code>string</code> |
|
|
|
|
Specifies a password for the new user.
|
|
|
|
### --login-type
|
|
|
|
| | |
|
|
|------|---------------------|
|
|
| Type | <code>string</code> |
|
|
|
|
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 | <code>string</code> |
|
|
| Environment | <code>$CODER_ORGANIZATION</code> |
|
|
|
|
Select which organization (uuid or name) to use.
|