Dan HeathandRobin Beck
5ce6515156
* docs: IA reorganization * docs: Updates * docs: Updates * docs: Fix links * docs: Updates * docs: Fix a typo * docs: Fix client agent topic * docs: Update Client Agent nav * docs: Fix conflict * docs: Fix a typo in Client Agent docs (#5853) * docs: Fix client agent topic * docs: Updates * docs: Updates * docs: Updates * docs: Updates * docs: Fixes get started and operations links * docs: Update nav * docs: Partials * docs: Unix partials * docs: Worker partials * docs: Updates * docs: Update workers and targets * docs: Updates * docs: Updates * docs: Fixes link * docs: Updates after sync review * docs: Updates from review feedback * docs: Move worker filter examples * docs: Fix links * docs: Updates for filters based on working session * docs: Fixes broken links * docs: Add links to other filter topics * docs: Update list intro * docs: Adds link * docs: Fixes redirects * docs: Fixes redirects * docs: Deleted mysql page from TOC * docs: Add versioned redirect * docs: Adds versioned redirects * docs: Adds versioned redirects * docs: Update redirects * docs: Update redirects * docs: Redirect fixes * docs: Update redirect format * docs: Fix a typo * docs: Fixes redirects * docs: Fixes redirect * docs: Adds links out to client agent troubleshooting * uses /etc/boundary.d/ as recommended installation directory (#6003) * docs: Updates legacy io links * docs: Fixes redirects * docs: Fix redirect * docs: Restoring deleted file --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
78 lines
3.0 KiB
Plaintext
78 lines
3.0 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Configure targets with credential brokering
|
|
description: >-
|
|
Configure credential brokering workflows so that Boundary centrally manages credentials and returns them to users when they successfully connect to a target.
|
|
---
|
|
|
|
# Configure targets with credential brokering
|
|
|
|
The following section provides steps to configure your targets with credential brokering.
|
|
When you use credential brokering, Boundary returns credentials to the user when they successfully connect to a target.
|
|
|
|
## Requirements
|
|
|
|
- You must have an existing target available. To use brokered credentials to connect to a target that runs SSH, you must use a TCP target type.
|
|
|
|
- You must have configured either a static credential store or a Vault credential store:
|
|
|
|
- To configure a static credential store, refer to [Create static credential stores](/boundary/docs/credentials/static-cred-boundary).
|
|
- To configure a Vault credential store and credential library, refer to [Create Vault credential stores](/boundary/docs/credentials/static-cred-vault).
|
|
|
|
- You must have a static credential saved in your static credential store or Vault credential store. The credential must correspond to the target you want to authenticate to.
|
|
|
|
## Configuration
|
|
|
|
Complete the following steps to configure credential brokering for a target:
|
|
|
|
<Tabs>
|
|
<Tab heading="UI" group="ui">
|
|
|
|
1. Log in to Boundary.
|
|
1. Select **Orgs** on the navigation pane.
|
|
1. Select your desired org.
|
|
1. Select the project where your target resides.
|
|
1. Click **Targets** on the navigation pane.
|
|
1. Click on the target you want to configure for credential brokering.
|
|
1. Click on the **Brokered Credential** tab.
|
|
1. Click **Managed** and select **Add Brokered Credential** in the pull down menu.
|
|
1. Do one of the following:
|
|
- **If you are using a static credential store**: Select the credential that corresponds to your target and click **Add Brokered Credentials**.
|
|
- **If you are using a Vault credential store**: Select the credential library that corresponds to your target and click **Add Brokered Credentials**.
|
|
|
|
</Tab>
|
|
<Tab heading="CLI" group="cli">
|
|
|
|
1. Log into Boundary.
|
|
|
|
```shell-session
|
|
$ boundary authenticate
|
|
Please enter the login name (it will be hidden):
|
|
Please enter the password (it will be hidden):
|
|
```
|
|
1. Add brokered credentials to target.
|
|
|
|
```shell-session
|
|
$ boundary targets add-credential-sources \
|
|
-id ttcp_vO60a7TwpI \
|
|
-application-credential-source csvlt_Xqa6V6QwfM
|
|
```
|
|
|
|
<Tip>
|
|
|
|
If you are using a static credential store, `brokered-credential-source` refers to the ID of a **credential** in the static credential store.
|
|
|
|
If you are using a Vault credential store, `brokered-credential-source` refers to the ID of a **credential library** in the Vault credential store.
|
|
|
|
</Tip>
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## More information
|
|
|
|
Refer to the following topics for more information:
|
|
|
|
- [Create static credential stores](/boundary/docs/credentials/static-cred-boundary)
|
|
- [Create Vault credential stores](/boundary/docs/credentials/static-cred-vault)
|
|
- [Target types](/boundary/docs/domain-model/targets#target-types) |