Dan Heath
3f4cd53d16
* docs: Update headings for new style rule * docs: Fix headings - Get started * docs: Fix headings - Install * docs: Fix headings - Concepts * docs: Fix typos * docs: Fix headings - Configuration * docs: Fix headings - Operations * docs: Fix headings - Troubleshoot * docs: Fix headings - Clients and Develop * docs: Fix headings - HCP and ENT * docs: Fix headings - Release notes * docs: Fix typos * docs: Fix capitalization in TOC
58 lines
1.8 KiB
Plaintext
58 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain model - groups
|
|
description: |-
|
|
The anatomy of a Boundary group
|
|
---
|
|
|
|
# Groups
|
|
|
|
A group is a resource
|
|
that represents a collection of [users][]
|
|
which can be treated equally
|
|
for the purposes of access control.
|
|
A group is a principal
|
|
which allows it to be assigned to [roles][].
|
|
Any role assigned to a group is indirectly assigned to the users in the group.
|
|
This assignment is a transitive property.
|
|
A user in a group receives all [permissions][] of the roles assigned to the group.
|
|
Groups can be defined at the [Global][], [Organization][], or [Project][] [scope][].
|
|
|
|
## Attributes
|
|
|
|
A group has the following configurable attributes:
|
|
|
|
- `name` - (optional)
|
|
If set, the `name` must be unique within the group's immediate parent [scope][].
|
|
|
|
- `description` - (optional)
|
|
|
|
## Referenced by
|
|
|
|
- [Global][]
|
|
- [Organization][]
|
|
- [Role][]
|
|
- [User][]
|
|
|
|
[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
|
|
[project]: /boundary/docs/concepts/domain-model/scopes#projects
|
|
[role]: /boundary/docs/concepts/domain-model/roles
|
|
[roles]: /boundary/docs/concepts/domain-model/roles
|
|
[scope]: /boundary/docs/concepts/domain-model/scopes
|
|
[user]: /boundary/docs/concepts/domain-model/users
|
|
[users]: /boundary/docs/concepts/domain-model/users
|
|
|
|
## Service API docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Group Service](/boundary/api-docs/group-service)
|
|
|
|
## Tutorial
|
|
|
|
Refer to the [Manage Users and Groups with HCP Boundary](/boundary/tutorials/hcp-administration/hcp-manage-users-groups) tutorial to learn how to complete user management related tasks.
|