Files
threshold/website/content/docs/concepts/domain-model/accounts.mdx
T
2179af63cb Hashidays Docs (#3313)
docs: add 0.13 feature docs

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Jeff Malnick <malnick@gmail.com>
Co-authored-by: Michael Li <michael.li@hashicorp.com>
Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Co-authored-by: XingLu Wang <95828202+xingluw@users.noreply.github.com>
Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2023-06-12 23:53:27 -07:00

81 lines
2.4 KiB
Plaintext

---
layout: docs
page_title: Domain Model - Accounts
description: |-
The anatomy of a Boundary account
---
# Accounts
An account is a resource
that represents a unique set of credentials
issued from a configured [auth method][]
which can be used to establish the identity of a user.
A [user][] can have zero or more accounts
but an account can only belong to a single user.
An account can only be associated with a user
in the same scope as the account's [auth method][].
## Attributes
All account types have the following configurable attributes:
- `name` - (optional)
If set, the `name` must be unique within the account's [auth method][].
- `description` - (optional)
### Password Account Attributes
Password account types have the following additional attributes:
- `login_name` - (required)
Must be unique within the account's [auth method][].
Can only contain lower case letters.
- `password` - (optional)
Not setting the `password` disables the account.
### LDAP Account Attributes <sup>Beta</sup>
LDAP account types have the following additional attributes:
- `login_name` - (required)
Must be unique within the account's [auth method][].
Can only contain lower case letters.
- `full_name` - (output only)
Maps to the name attribute for the authenticated user, and is updated every
time the user successfully authenticates. It is empty until the user's
first successful authentication.
- `email` - (output only)
Maps to the email address attribute for the authenticated user, and is updated
every time the user successfully authenticates. It is empty until the
user's first successful authentication.
- `dn` - (output only)
Maps to the distinguished name for the authenticated user, and is updated
every time the user successfully authenticates. It is empty until the
user's first successful authentication.
- `member_of_groups` - (output only)
A list of the groups the authenticated user is a member of. It is empty
until the user's first successful authentication.
## Referenced By
- [Auth Method][]
- [Managed Group][]
- [User][]
[auth method]: /boundary/docs/concepts/domain-model/auth-methods
[managed group]: /boundary/docs/concepts/domain-model/managed-groups
[user]: /boundary/docs/concepts/domain-model/users
## Service API Docs
The following services are relevant to this resource:
- [Account Service](/boundary/api-docs/account-service)