Files
threshold/website/content/docs/commands/accounts/create.mdx
T
ad5ad69d54 [Assembly] Boundary Commands (CLI) docs (#3411)
* Add 'Commands (CLI)' docs

* Update index.mdx

Added Environment variables section

* Add 'connect' sub-folder structure

* Adding listen address and port environment variables

* add connect to the docs navigation

* docs: Add Florin's update to index

* docs: Fix links and typo

* Add front-matter to resolve the PR check issue

* Update postgres.mdx

Boundary helper for POSTGRES

* Completed 'boundary accounts' command docs

* Draft connection option documentatino for kube, http, and rdp (#3455)

* Style updates for consistency

* Clean up using partials

* Add 'ssh' doc & updated style for consistency

* Fix paste error

* Fix the format issue on 'connect ssh' doc

* Add 'auth-methods' command doc (#3520)

* Add the docs for 'logout', 'server', and 'dev' commands (#3524)

* Add the docs for 'logout', 'server', and 'dev' commands

* Update the front matter

* Add auth-tokens and authenticate command docs (#3575)

* Add config command docs (#3576)

* updates to the ssh helper command docs (#3523)

* updates to the ssh helper command docs

* docs: Fix code block

* docs: Add minor copy edits

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

* docs: Add worker commands

* docs: Update workers subcommands (#3598)

* docs: Update worker subcommands

* docs: Update certificate-authority subcommand

* doc: Fix syntax for code refererences

* docs: Add `users` commands (#3599)

* docs: Add `users` commands

* docs: Add more subcommands

* docs: Add `target` commands (#3608)

* Add command docs for 'credential-libraries' (#3610)

* Add 'credential-stores' command docs (#3611)

* Add 'credential-stores' command docs

* Add the output message

* Fix a typo

* Fix a typo

* Update the dummy token value

* docs: Add `storage-bucket` commands - update (#3615)

* docs: Add `sessions` commands (#3616)

* docs: Add `session-recordings` commands (#3617)

* Add 'credentials' command docs (#3619)

* Add 'credentials' command docs

* Fix typos

* docs: Add `scopes` commands (#3620)

* docs: Add `scopes` commands

* docs: Fix typos

* docs: Add `roles` commands (#3621)

* docs: Add `roles` commands

* docs: Add remaining subcommands

* Add 'database' command docs (#3628)

* Add 'database' command docs

* Update the format inconsistency

* docs: Add `managed-groups` commands (#3626)

* docs: Add `managed-groups` commands

* docs: Clarify description

* docs: Add `hosts` commands (#3629)

* docs: Add `host-sets` commands (#3630)

* docs: Add `host-sets` commands

* docs: Copy edits

* docs: Add `host-catalogs` commands (#3632)

* Add 'boundary groups' command docs (#3636)

---------

Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com>
Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com>
Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
2023-09-12 14:37:31 -04:00

190 lines
4.4 KiB
Plaintext

---
layout: docs
page_title: accounts create - Command
description: |-
The "accounts create" command lets Boundary admin create a new account resource.
---
# accounts create
Command: `boundary accounts create`
The `accounts create` command lets you create an account associated with one of the following auth methods:
- LDAP
- OIDC
- Password
## Example
The following example creates an account named `test_account`. In this example, you provide a password when prompted:
```shell-session
$ boundary accounts create password \
-auth-method-id=ampw_1234567890 \
-login-name="tester01" \
-name=test_account \
-description="Test password account"
```
**Example output:**
<CodeBlockConfig hideClipboard>
```plaintext
Please enter the password (it will be hidden):
Account information:
Auth Method ID: ampw_ZbB6UXpW3B
Created Time: Fri, 27 May 2022 11:16:47 MDT
Description: Test password account
ID: acctpw_A8R1escktO
Name: test_account
Type: password
Updated Time: Fri, 27 May 2022 11:16:47 MDT
Version: 1
Scope:
ID: o_u54jrD6ydN
Name: IT_Support
Parent Scope ID: global
Type: org
Authorized Actions:
no-op
read
update
delete
set-password
change-password
Attributes:
Login Name: tester01
```
</CodeBlockConfig>
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary accounts create [type] [options] [args]
```
</CodeBlockConfig>
### Command options
- `-auth-method-id` `(string: "")` - The auth-method resource to use for the
operation. You can also specify the auth-method using the **BOUNDARY_AUTH_METHOD_ID**
environment variable.
- `-description` `(string: "")` - The description to set for the account.
- `-name` `(string: "")` - The name to set on the account.
### Usages by type
You can create `ldap`, `oidc`, and `password` type accounts.
<Tabs>
<Tab heading="LDAP">
The `boundary accounts create ldap` command creates an account of `ldap` type.
#### Example
The example below creates an LDAP account with the login name `prodops` and the description `ldap account for ProdOps`:
```shell-session
$ boundary accounts create ldap -login-name prodops \
-description "ldap account for ProdOps"
```
#### Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary accounts create ldap [options] [args]
```
</CodeBlockConfig>
#### LDAP account option
The following option is LDAP-specific, in addition to the command options:
- `-login-name` `(string: "")` - The login name for the account.
</Tab>
<Tab heading="OIDC">
The `boundary accounts create oidc` command creates an account of `oidc` type.
#### Example
The following example creates an OIDC account with the subject `prodops` and the description `Oidc account for ProdOps`:
```shell-session
$ boundary accounts create oidc -subject "prodops" \
-description "Oidc account for ProdOps"
```
#### Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary accounts create oidc [options] [args]
```
</CodeBlockConfig>
#### OIDC account options
The following options are OIDC-specific, in addition to the command options:
- `-issuer` `(string: "")` - The issuer for the account.
- `-subject` `(string: "")` - The subject for this account on the OIDC provider.
</Tab>
<Tab heading="Password">
The `boundary accounts create password` command creates an account of `password` type.
#### Example
The following example creates a password-type account with the login name `prodops` and the description `Password account for ProdOps`:
```shell-session
$ boundary accounts create password -login-name prodops \
-description "Password account for ProdOps"
```
#### Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary accounts create password [options] [args]
```
</CodeBlockConfig>
#### Password account options
The following options are password-specific, in addition to the command
options:
- `-login-name` `(string: "")` - The login name for the account
- `-password` `(string: "")` - The password for the account. If blank, the
command prompts you to enter the password interactively in a
non-echoing way. Otherwise, this value can refer to a file on disk (`file://`) or an environment variable (`env://`) from which the password is read.
</Tab>
</Tabs>
@include 'cmd-option-note.mdx'