Files
coder/docs/reference/cli/users/create.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

74 lines
1.9 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: "`coder users create`"
description: Create a new user.
---
2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Create a new user.
2023-03-23 17:42:20 -05:00
## Usage
```console
coder users create [flags]
```
## Options
### -e, --email
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
2023-03-23 17:42:20 -05:00
Specifies an email address for the new user.
### -u, --username
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specifies a username for the new user.
### -n, --full-name
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specifies an optional human-readable name for the new user.
2023-03-23 17:42:20 -05:00
### -p, --password
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
2023-03-23 17:42:20 -05:00
Specifies a password for the new user.
### --login-type
2023-03-23 17:42:20 -05:00
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
2023-03-23 17:42:20 -05:00
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. Deprecated: 'none' is deprecated. Use service accounts (requires Premium) for machine-to-machine access, or password/github/oidc login types for regular user accounts.
### --service-account
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Create a user account intended to be used by a service or as an intermediary rather than by a human.
### -O, --org
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.