2020-07-27 10:59:08 -07:00
---
layout: docs
2023-07-07 14:42:11 -04:00
page_title: Domain model - groups
2020-07-27 10:59:08 -07:00
description: |-
2020-10-10 16:40:06 -04:00
The anatomy of a Boundary group
2020-07-27 10:59:08 -07:00
---
2020-10-10 16:40:06 -04:00
# Groups
2020-07-27 10:59:08 -07:00
2020-10-11 15:05:15 -04:00
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.
2020-10-12 18:18:17 -04:00
Groups can be defined at the [Global][], [Organization][], or [Project][] [scope][].
2020-10-11 15:05:15 -04:00
## 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)
2023-07-07 14:42:11 -04:00
## Referenced by
2020-10-11 15:05:15 -04:00
- [Global][]
- [Organization][]
- [Role][]
- [User][]
2023-01-20 18:17:34 -05:00
[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
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
- [Group Service](/boundary/api-docs/group-service)
2022-07-12 12:29:35 -07:00
## Tutorial
2023-01-20 18:17:34 -05:00
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.
