A directory group is a set of directory users. Use groups to assign people to
applications, and to tell applications what people belong to: the groups claim carries group
names. Directory groups are separate from IAM groups, which hold members.
Group fields
| Field | Description |
|---|---|
id, slug, resourceName |
The group’s ID (a UUID), slug (dgp_…) and resource name, ezgh:us-west-1:org_…:dir_…:dgp_…. |
name |
1 to 128 characters, unique in the directory (409 group_name_taken). Applications see it in the groups claim. |
description |
Up to 1,024 characters. |
tags |
Up to 50 key-value pairs, as for the directory. |
memberCount |
How many users are in the group. |
source |
hosted (created by you) or scim (pushed by your identity provider’s SCIM). |
locked |
true while the group’s identity provider manages it over SCIM: renaming it, deleting it and changing its members are then 409 managed_by_scim. |
Create and change groups
ezgh sso groups create engineering --description "Everyone in engineering"
ezgh sso groups add-members engineering ada@acme.com grace@acme.com
ezgh sso groups members engineeringAPI: CreateGroup, UpdateGroup, DeleteGroup, ListGroupMembers, AddGroupMembers and RemoveGroupMembers.
- Member changes take
{ "userIds": [...] }, 1 to 100 user IDs at a time. Adding a user who is already a member, or removing one who isn’t, changes nothing. Every ID must be a user of the directory, or the request is400. - Group responses carry an
ETag, which covers the name, description, tags and members. Updates, deletes and member changes takeIf-Match: if the group changed since you read it, the request is412 precondition_failedand nothing changes. WithoutIf-Matchthe change applies. - Deleting a group removes its memberships and its assignments.
- An identity provider’s group mappings can add people to groups you created when they sign in.
- You can add users provisioned by SCIM to groups you created. A group’s name is unique in the directory, whether you created it or SCIM pushed it.
Membership changes apply at once: the next token an application gets, and every assignment check, use the current members.