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>
53 lines
2.2 KiB
Plaintext
53 lines
2.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: targets authorize-session - Command
|
|
description: |-
|
|
The "targets authorize-session" lets you fetch session authorization credentials for a target.
|
|
---
|
|
|
|
# targets authorize-session
|
|
|
|
Command: `targets authorize-session`
|
|
|
|
The `targets authorize-session` command lets you fetch session authorization credentials for a target so that you can start a session later.
|
|
|
|
## Examples
|
|
|
|
This example fetches authorization credentials for a target with the ID `ttcp_wtXnow8Krb` and a specific host with the ID `hst_DHei2VpkBH`:
|
|
|
|
```shell-session
|
|
$ boundary targets authorize-session -id=ttcp_wtXnow8Krb -host-id=hst_DHei2VpkBH
|
|
```
|
|
|
|
You can also request an authorized session using the scope ID and target name.
|
|
This example requests authorization credentials using the scope ID `o_1234567890` and the target name `prod-ssh`:
|
|
|
|
```shell-session
|
|
$ boundary targets authorize-session -scope-id o_1234567890 -name prod-ssh
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary targets authorize-session [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-host-id=<string>` - The ID of a host from the target's host sets.
|
|
If you specify a host, Boundary uses that specific host for the connection.
|
|
If you do not specify a host, Boundary chooses one at random.
|
|
- `-id=<string>` - The ID of the target you want to authorize a session for.
|
|
- `-name=<string>` - The name of the target you want to fetch credentials for, if you want to authorize the session using scope parameters and target name.
|
|
- `-scope-id=<string>` - The scope ID of the target you want to fetch credentials for, if you want to authorize the session using scope parameters and target name.
|
|
Alternatively, you can specify a scope ID using the **BOUNDARY_SCOPE_ID** environment variable.
|
|
You cannot specify a scope ID if you specify a `-scope-name<string>`.
|
|
- `-scope-name=<string>` - The scope name of the target you want to fetch credentials for, if you want to authorize the session using scope parameters and target name.
|
|
Alternatively, you can specify a scope name using the **BOUNDARY_SCOPE_NAME** environment variable.
|
|
You cannot specify a scope name if you specify a `-scope-id<string>`.
|
|
|
|
@include 'cmd-option-note.mdx' |