4ffb21f9ca
* Update documentation to include RDP in credential injection * Update FAQ on Boundary and Vault integration Fixed typo. * update documentation on credential stores and workflows for RDP * update static credential store documentation to include upd credential creation * update documentation for credential injection setup * Update 'credentials create' command documentation for upd credential type * fixed typo in UPD options * Update create.mdx with instructions for RDP targets * Create rdp-testing-and-compatibility-matrix.mdx * Update rdp-testing-and-compatibility-matrix.mdx * Update rdp-testing-and-compatibility-matrix.mdx * Update to mention ldap secrets engine * Update rdp-testing-and-compatibility-matrix.mdx to get rid of ticket number * updated to include mention of vault kv and chad suggestions Updated with Chad's suggestions and vault kv * Update rdp-testing-and-compatibility-matrix.mdx Found another place where I neglected the vault kv * docs: Style updates * docs: Clean up beta references, adds update commands * docs: Edits, update domain model topics * docs: Add target address caveats * docs: Edit network config section * docs: Use custom port number to connect * docs: Adds anchor link, beta tag * docs: Respond to feedback * docs: Cleanup for consistency, remove known issue * docs: Cleanup and minor fixes * docs: Add link to create issue * docs: Add direct address note to targets CLI topics * Update website/content/docs/concepts/credential-management.mdx Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com> * docs: Remove beta references from target and credentials * docs: Remove Vault cred store ID * docs: Remove SSH cert from brokered creds * docs: Remove session recording options * docs: Adds UPD to credential stores domain model topic * Update website/content/docs/credentials/rdp-testing-and-compatibility-matrix.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update website/content/docs/credentials/rdp-testing-and-compatibility-matrix.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Remove session recording options * docs: Update limitations and configuration * Update website/content/docs/credentials/configure-credential-injection.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Update default port commands * docs: Add known issue for error * docs: Fix typo * Update website/content/docs/credentials/rdp-testing-and-compatibility-matrix.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Add certificate acceptance to Windows * docs: Reorder UPD options * docs: Add NTLMV2 to cred management statement * docs: Update Windows Remote Desktop Connection error * docs: Clarify domain behavior * docs: Fix back ticks on command options * docs: Update command format in definition * docs: Clarify port conflict with Remote Desktop app * docs: Update RDP target address caveat * docs: Release notes 0.20.0 * docs: Minor edit * docs: Vercel build * docs: Deletes older important changes --------- Co-authored-by: Dan Rohan <daniel.rohan@elastic.co> Co-authored-by: Dan Rohan <dan.rohan@hashicorp.com> Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
95 lines
2.9 KiB
Plaintext
95 lines
2.9 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Credential resource
|
|
description: >-
|
|
Learn about using the credential resource to define secrets for a host. Understand username password, SSH private key, SSH certificate, and JSON credential types.
|
|
---
|
|
|
|
# Credentials
|
|
|
|
A credential is a data structure containing one or more secrets that binds an identity to a set of permissions or capabilities on a [host][] for a [session][].
|
|
|
|
Optionally, credentials can be typed to indicate compliance with a specific format.
|
|
The following credential types are supported in Boundary:
|
|
|
|
- [Username password](#username-password)
|
|
- [Username password domain](#username-password-domain)
|
|
- [SSH private key](#ssh-private-key)
|
|
- [SSH certificate](#ssh-certificate)
|
|
- [JSON](#json)
|
|
|
|
## Username password
|
|
|
|
`username_password` credentials contain the following fields:
|
|
|
|
- `username` - The username field associated with the credential.
|
|
|
|
- `password` - The password field associated with the credential.
|
|
|
|
## Username password domain
|
|
|
|
`username_password_domain` credentials contain the following fields:
|
|
|
|
- `username` - The username field associated with the credential.
|
|
|
|
- `password` - The password field associated with the credential.
|
|
|
|
- `domain` - The domain field associated with the credential.
|
|
|
|
## SSH private key
|
|
|
|
`ssh_private_key` credentials contain the following fields:
|
|
|
|
- `username` - The username field associated with the credential.
|
|
|
|
- `private_key` - The private key field associated with the credential.
|
|
|
|
## SSH certificate
|
|
|
|
`ssh_certificate` credentials contain the following fields:
|
|
|
|
- `username` - The username field associated with the credential.
|
|
|
|
- `ssh_certificate` - The SSH certificate associated with the credential.
|
|
|
|
## JSON
|
|
|
|
You can provide credentials using a JSON blob.
|
|
JSON credentials are only brokered to users that connect to machines.
|
|
There is no required structure for the JSON blob, other than it must be a key value map.
|
|
Refer to the example below:
|
|
|
|
<CodeBlockConfig heading="JSON credentials blob example">
|
|
|
|
```JSON
|
|
{
|
|
"type": "service_account",
|
|
"project_id": "",
|
|
"private_key_id": "",
|
|
"private_key": "-----BEGIN PRIVATE KEY----------END PRIVATE KEY-----\n",
|
|
"client_email": "",
|
|
"client_id": "",
|
|
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
|
|
"token_uri": "https://oauth2.googleapis.com/token",
|
|
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
|
|
"client_x509_cert_url": ""
|
|
}
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Referenced by
|
|
|
|
- [Credential store][]
|
|
- [Credential library][]
|
|
- [Session][]
|
|
- [Target][]
|
|
|
|
[credential library]: /boundary/docs/domain-model/credential-libraries
|
|
[credential libraries]: /boundary/docs/domain-model/credential-libraries
|
|
[credential store]: /boundary/docs/domain-model/credential-stores
|
|
[credential stores]: /boundary/docs/domain-model/credential-stores
|
|
[host]: /boundary/docs/domain-model/hosts
|
|
[session]: /boundary/docs/domain-model/sessions
|
|
[target]: /boundary/docs/domain-model/targets
|