User group endpoints
Groups are used to assign roles to a group of users, which
is vastly more efficient than managing roles for each user individually. The groups
endpoints enable you to get lists of
groups, and to add a new directory group.
Remember: Group membership is
determined by the directory service hierarchy and as such, local users cannot be in
directory groups.
-
User group keys
The following keys are used with the RBAC v1 API'sgroups
endpoints. -
GET /groups
Fetches all groups. Supports filtering by ID through query parameters. Authentication is required. -
GET /groups/<sid>
Fetches a single group by its subject ID (sid). Authentication is required. -
POST /groups
Creates a new remote group and attaches to the new group any roles specified in its roles list. Authentication is required. -
PUT /groups/<sid>
Replaces the group with the specified ID (sid) with a new group object. Authentication is required. -
DELETE /groups/<sid>
Deletes the user group with the specified ID (sid) from RBAC without making any changes to the directory service. Authentication required.