ad5ad69d54
* 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>
92 lines
2.9 KiB
Plaintext
92 lines
2.9 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: config get-token - Command
|
|
description: |-
|
|
The "config get-token" command fetches a token stored by the Boundary CLI.
|
|
---
|
|
|
|
# config get-token
|
|
|
|
Command: `boundary config get-token`
|
|
|
|
The `config get-token` command fetches a token stored by the Boundary CLI.
|
|
|
|
## Examples
|
|
|
|
The following command gets the token stored by the Boundary CLI:
|
|
|
|
```shell-session
|
|
$ boundary config get-token
|
|
```
|
|
|
|
**Example output:**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
at_yczA5UPS7Y_s13B5PWh7KENvtKQKgDxaEvP682FMfq5eXrpzKNTpmaHgLS2ucRexrTQ7ueMhDFY5MdFvNuzuTWzUzYgacitnSBaPo75b3XZU4Zp6wmdsXqmkPNY3U
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
This command can be useful in various situations. For example, developers could share a line such as the following in a shell script, such that each
|
|
developer on their own machine executes the script using their own
|
|
Boundary token:
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ curl --header "Authorization: Bearer $(boundary config get-token)" \
|
|
--header "Content-Type: application/json" \
|
|
http://127.0.0.1:9200/v1/roles/r_1234567890
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
This command keeps parity with the behavior of other Boundary commands; if you set the
|
|
`BOUNDARY_TOKEN` environment variable, it overrides the value loaded
|
|
from the system store. Not only does this keep parity, but it also allows
|
|
examples such as the one above to work even if there is no stored token, but you specified
|
|
an environment variable.
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary config get-token [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-account-id` - Prints out the account ID
|
|
associated with the token instead of the token itself, if specified. The default value is
|
|
`false`.
|
|
|
|
- `-auth-method-id` - Prints out the auth method ID
|
|
associated with the token instead of the token itself, if specified. The default value is `false`.
|
|
|
|
- `-keyring-type` `(string: "")` - Indicates the type of keyring to use. This value defaults to
|
|
`auto` which uses the Windows credential manager, OSX keychain, or
|
|
cross-platform password store depending on the platform. Set this value to `none` to disable
|
|
keyring functionality. The following keyring types are available, depending on platform:
|
|
|
|
- `wincred`
|
|
- `keychain`
|
|
- `pass`
|
|
- `secret-service`
|
|
|
|
You can also specify the keyring type using the **BOUNDARY_KEYRING_TYPE** environment
|
|
variable.
|
|
|
|
- `-token-name` `(string: "")` - Indicates whether the given value should be used as
|
|
the name when loading the token from the system credential store. This value must
|
|
correspond to a name used when authenticating. You can also specify the token name using
|
|
the **BOUNDARY_TOKEN_NAME** environment variable.
|
|
|
|
- `-user-id` - Prints out the user ID associated
|
|
with the token instead of the token itself, if specified. The default value is `false`.
|
|
|
|
@include 'cmd-option-note.mdx' |