60 lines
1.7 KiB
Plaintext
60 lines
1.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain Model - Credential Libraries
|
|
description: |-
|
|
The anatomy of a Boundary credential library
|
|
---
|
|
|
|
# Credential Libraries
|
|
|
|
A credential library is a resource
|
|
that provides [credentials][]
|
|
of the same type and same access level
|
|
from a single [credential store][].
|
|
|
|
## Attributes
|
|
|
|
A credential library has the following configurable attributes:
|
|
|
|
- `name` - (optional)
|
|
If set, the `name` must be unique within the credential library's parent
|
|
[credential store][].
|
|
|
|
- `description` - (optional)
|
|
|
|
### Vault Credential Library Attributes
|
|
|
|
A Vault credential library has the following additional attributes:
|
|
|
|
- `path` - (required)
|
|
The path in Vault to request credentials from.
|
|
|
|
- `http_method` - (optional: defaults to `GET`)
|
|
The HTTP method the library uses when requesting credentials from Vault.
|
|
Can be either `GET` or `POST`.
|
|
|
|
- `http_request_body` - (optional)
|
|
The body of the HTTP request the library sends to Vault when requesting credentials.
|
|
Only valid if `http_method` is set to `POST`.
|
|
|
|
## Referenced By
|
|
|
|
- [Credential][]
|
|
- [Credential Store][]
|
|
- [Target][]
|
|
|
|
[credential store]: /docs/concepts/domain-model/credential-stores
|
|
[credential stores]: /docs/concepts/domain-model/credential-stores
|
|
[credential]: /docs/concepts/domain-model/credentials
|
|
[credentials]: /docs/concepts/domain-model/credentials
|
|
[project]: /docs/concepts/domain-model/scopes#projects
|
|
[projects]: /docs/concepts/domain-model/scopes#projects
|
|
[target]: /docs/concepts/domain-model/targets
|
|
[targets]: /docs/concepts/domain-model/targets
|
|
|
|
## Service API Docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Credential Library Service](/api-docs/credential-library-service)
|