You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
boundary/website/content/docs/concepts/domain-model/managed-groups.mdx

72 lines
2.5 KiB

---
layout: docs
page_title: Domain model - managed groups
description: |-
The anatomy of a Boundary managed group
---
# Managed groups
A managed group is a resource that represents a collection of [accounts][]. The
collection is formed by evaluating account information defined by the [auth
method][]'s identity provider against the managed group's configuration; members
cannot be managed manually. An account can be associated with zero or more
managed groups within the same [auth method][]. The managed group can be used as
a principal within [roles][] to assign grants.
## Attributes
All managed group types have the following configurable attributes:
- `name` - (optional)
If set, the `name` must be unique within the account's [auth method][].
- `description` - (optional)
### OIDC managed group information and attributes
Membership in OIDC managed groups is evaluated when the auth method is used for
authentication, based on information contained within the OIDC ID token and the
OIDC User Info endpoint. Every authentication will result in a new evaluation of
managed group membership.
OIDC managed groups have the following additional attributes:
- `filter` - (required)
A boolean expression defining a filter run against the provided information.
For general syntax information see the [filtering concepts][] page; for more
specific information on the data available for this purpose see the [OIDC
Managed Groups Filtering][] page.
[filtering concepts]: /boundary/docs/concepts/filtering
[oidc managed groups filtering]: /boundary/docs/concepts/filtering/oidc-managed-groups
### LDAP managed group information and attributes
Membership in LDAP managed groups is evaluated when the auth method is used for
authentication, based on information contained within the LDAP server. Every
authentication results in a new evaluation of managed group membership.
LDAP managed groups have the following additional attributes:
- `group-names` - (required)
A list of group names.
## Referenced by
- [Accounts][]
- [Auth Method][]
[accounts]: /boundary/docs/concepts/domain-model/accounts
[auth method]: /boundary/docs/concepts/domain-model/auth-methods
[roles]: /boundary/docs/concepts/domain-model/roles
## Service API docs
The following services are relevant to this resource:
- [Managed Group Service](/boundary/api-docs/managed-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.