Identity Cloud

Managed groups

Groups are exposed under the context path /managed/group. The following table lists the REST commands associated with managed groups.

URI HTTP Operation Description

/openidm/managed/group?_queryFilter=true&_fields=_id

GET

Lists the IDs of all managed groups.

/openidm/managed/group?_queryFilter=filter

GET

Queries managed groups with the defined filter.

/openidm/managed/group/_id

GET

Returns the JSON representation of a specific group.

/openidm/managed/group/_id?_fields=*_ref,name

GET

Returns the relationships (members) associated with a group.

/openidm/managed/group/_id/members?_queryFilter=true

GET

Lists the members of a group.

/openidm/managed/group/_id

PUT

Creates a group with a user-defined ID.

/openidm/managed/group/_id/members?_action=create

POST

Adds a member to a group.

/openidm/managed/group/_id

PUT

Updates a group (replaces the entire object).

/openidm/managed/group?_action=create

POST

Creates a new group with a system-generated ID.

/openidm/managed/group/_id

DELETE

Deletes a group.

For a number of sample commands that show how to manage groups over REST, see Groups.

Copyright © 2010-2022 ForgeRock, all rights reserved.