2020-10-05 08:54:06 -07:00
---
layout: docs
2024-12-04 11:01:09 -05:00
page_title: Account resource
description: >-
Learn about using the accounts resource to establish the identities of users. Understand how to configure general, password, and LDAP account attributes.
2020-10-05 08:54:06 -07:00
---
2020-10-10 16:40:06 -04:00
# Accounts
2020-10-05 08:54:06 -07:00
2020-10-11 12:47:45 -04:00
An account is a resource
that represents a unique set of credentials
2020-10-12 16:19:13 -04:00
issued from a configured [auth method][]
2020-10-11 12:47:45 -04:00
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.
2020-10-12 18:18:17 -04:00
An account can only be associated with a user
in the same scope as the account's [auth method][].
2020-10-05 08:54:06 -07:00
## Attributes
2020-10-11 12:47:45 -04:00
All account types have the following configurable attributes:
- `name` - (optional)
2020-10-12 16:19:13 -04:00
If set, the `name` must be unique within the account's [auth method][].
2020-10-11 12:47:45 -04:00
- `description` - (optional)
2023-07-07 14:42:11 -04:00
### Password account attributes
2020-10-11 12:47:45 -04:00
Password account types have the following additional attributes:
- `login_name` - (required)
2020-10-12 16:19:13 -04:00
Must be unique within the account's [auth method][].
2020-10-11 12:47:45 -04:00
Can only contain lower case letters.
- `password` - (optional)
Not setting the `password` disables the account.
2023-10-11 11:32:44 -04:00
### LDAP account attributes
2023-03-15 11:40:40 -04:00
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
2023-06-13 08:53:27 +02:00
user's first successful authentication.
2023-03-15 11:40:40 -04:00
- `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.
2023-07-07 14:42:11 -04:00
## Referenced by
2020-10-11 12:47:45 -04:00
2020-10-12 16:19:13 -04:00
- [Auth Method][]
2021-06-09 07:55:02 -05:00
- [Managed Group][]
2020-10-11 14:21:04 -04:00
- [User][]
2020-10-11 12:47:45 -04:00
2023-01-20 18:17:34 -05:00
[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
2020-10-12 17:40:42 -04:00
2023-07-07 14:42:11 -04:00
## Service API docs
2020-10-12 17:40:42 -04:00
The following services are relevant to this resource:
2023-01-20 18:17:34 -05:00
- [Account Service](/boundary/api-docs/account-service)