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>
61 lines
1.8 KiB
Plaintext
61 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: User resource
|
|
description: >-
|
|
Learn how the user resource identifies a person or entity for access control purposes. Understand how to assign groups and roles so users inherit permissions.
|
|
---
|
|
|
|
# Users
|
|
|
|
A user is a resource
|
|
that represents an individual person or entity
|
|
for the purposes of access control.
|
|
A user can be associated with zero or more [accounts][].
|
|
A user authenticates to Boundary through an associated account
|
|
and must be associated with at least one account before they can access Boundary.
|
|
|
|
A user is also a principal
|
|
which allows it to be assigned to [roles][].
|
|
A user receives all the [permissions][]
|
|
of the roles assigned directly to the user
|
|
and all the permissions of roles assigned to [groups][] the user is in.
|
|
|
|
Users can be defined at either a [global][] or [organization][] [scope][].
|
|
A user can only be associated with accounts from an [auth method][]
|
|
configured in the same scope.
|
|
|
|
## Attributes
|
|
|
|
A user has the following configurable attributes:
|
|
|
|
- `name` - (optional)
|
|
If set, the `name` must be unique within the user's immediate parent scope.
|
|
|
|
- `description` - (optional)
|
|
|
|
## Referenced by
|
|
|
|
- [Account][]
|
|
- [Global][]
|
|
- [Group][]
|
|
- [Organization][]
|
|
- [Role][]
|
|
|
|
[account]: /boundary/docs/domain-model/accounts
|
|
[accounts]: /boundary/docs/domain-model/accounts
|
|
[auth method]: /boundary/docs/domain-model/auth-methods
|
|
[global]: /boundary/docs/domain-model/scopes#global
|
|
[group]: /boundary/docs/domain-model/groups
|
|
[groups]: /boundary/docs/domain-model/groups
|
|
[organization]: /boundary/docs/domain-model/scopes#organizations
|
|
[permissions]: /boundary/docs/rbac
|
|
[role]: /boundary/docs/domain-model/roles
|
|
[roles]: /boundary/docs/domain-model/roles
|
|
[scope]: /boundary/docs/domain-model/scopes
|
|
|
|
## Service API docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [User service](/boundary/api-docs/user-service)
|