2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
layout: docs
|
2023-07-07 14:42:11 -04:00
|
|
|
page_title: Domain model - users
|
2020-07-27 10:59:08 -07:00
|
|
|
description: |-
|
2020-10-10 16:40:06 -04:00
|
|
|
The anatomy of a Boundary user
|
2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
|
2020-10-10 16:40:06 -04:00
|
|
|
# Users
|
2020-07-27 10:59:08 -07:00
|
|
|
|
2020-10-11 15:34:39 -04:00
|
|
|
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][].
|
2020-10-12 14:52:46 -04:00
|
|
|
A user authenticates to Boundary through an associated account
|
|
|
|
|
and must be associated with at least one account before they can access Boundary.
|
2020-10-11 15:34:39 -04:00
|
|
|
|
2020-10-12 14:52:46 -04:00
|
|
|
A user is also a principal
|
2020-10-11 15:34:39 -04:00
|
|
|
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][].
|
2020-10-12 16:19:13 -04:00
|
|
|
A user can only be associated with accounts from an [auth method][]
|
2020-10-11 15:34:39 -04:00
|
|
|
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)
|
|
|
|
|
|
2023-07-07 14:42:11 -04:00
|
|
|
## Referenced by
|
2020-10-11 15:34:39 -04:00
|
|
|
|
|
|
|
|
- [Account][]
|
|
|
|
|
- [Global][]
|
|
|
|
|
- [Group][]
|
|
|
|
|
- [Organization][]
|
|
|
|
|
- [Role][]
|
|
|
|
|
|
2023-01-20 18:17:34 -05:00
|
|
|
[account]: /boundary/docs/concepts/domain-model/accounts
|
|
|
|
|
[accounts]: /boundary/docs/concepts/domain-model/accounts
|
|
|
|
|
[auth method]: /boundary/docs/concepts/domain-model/auth-methods
|
|
|
|
|
[global]: /boundary/docs/concepts/domain-model/scopes#global
|
|
|
|
|
[group]: /boundary/docs/concepts/domain-model/groups
|
|
|
|
|
[groups]: /boundary/docs/concepts/domain-model/groups
|
|
|
|
|
[organization]: /boundary/docs/concepts/domain-model/scopes#organizations
|
|
|
|
|
[permissions]: /boundary/docs/concepts/security/permissions
|
|
|
|
|
[role]: /boundary/docs/concepts/domain-model/roles
|
|
|
|
|
[roles]: /boundary/docs/concepts/domain-model/roles
|
|
|
|
|
[scope]: /boundary/docs/concepts/domain-model/scopes
|
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
|
|
|
- [User Service](/boundary/api-docs/user-service)
|
