Dan HeathandRobin Beck
b442c1fa60
* docs: Update meta content - CLI * docs: Edits for consistency * docs: More edits for consistency * Apply batch of suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Apply batch suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Remove given id references * Update read.mdx * Update read.mdx --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
71 lines
1.3 KiB
Plaintext
71 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: accounts read - Command
|
|
description: >-
|
|
The "accounts read" command retrieves the account details for an account.
|
|
---
|
|
|
|
# accounts read
|
|
|
|
Command: `boundary accounts read`
|
|
|
|
The `accounts read` command retrieves the account details for a given account ID.
|
|
|
|
|
|
## Examples
|
|
|
|
The following example reads any account information with the ID `acctpw_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary accounts read -id acctpw_1234567890
|
|
```
|
|
|
|
**Example output:**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Account information:
|
|
Auth Method ID: ampw_1234567890
|
|
Created Time: Wed, 12 Jul 2023 12:20:54 PDT
|
|
ID: acctpw_1234567890
|
|
Type: password
|
|
Updated Time: Wed, 12 Jul 2023 22:29:59 PDT
|
|
Version: 5
|
|
|
|
Scope:
|
|
ID: global
|
|
Name: global
|
|
Type: global
|
|
|
|
Authorized Actions:
|
|
no-op
|
|
read
|
|
update
|
|
delete
|
|
set-password
|
|
change-password
|
|
|
|
Attributes:
|
|
Login Name: admin
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary accounts read [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
|
|
### Command options
|
|
|
|
- `-id` `(string: "")` - The ID of the account to read.
|
|
|
|
@include 'cmd-option-note.mdx'
|