55 lines
1.5 KiB
Plaintext
55 lines
1.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain Model - Groups
|
|
sidebar_title: 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]: /docs/concepts/domain-model/scopes#global
|
|
[group]: /docs/concepts/domain-model/groups
|
|
[groups]: /docs/concepts/domain-model/groups
|
|
[organization]: /docs/concepts/domain-model/scopes#organizations
|
|
[permissions]: /docs/concepts/security/permissions
|
|
[project]: /docs/concepts/domain-model/scopes#projects
|
|
[role]: /docs/concepts/domain-model/roles
|
|
[roles]: /docs/concepts/domain-model/roles
|
|
[scope]: /docs/concepts/domain-model/scopes
|
|
[user]: /docs/concepts/domain-model/users
|
|
[users]: /docs/concepts/domain-model/users
|
|
|
|
## Service API Docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Group Service](/api-docs/group-service)
|