Identity Cloud

Managed groups

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

URI HTTP Operation Description

/openidm/managed/realm-name_group?_queryFilter=true&_fields=_id

GET

Lists the IDs of all managed groups.

/openidm/managed/realm-name_group?_queryFilter=filter

GET

Queries managed groups with the defined filter.

/openidm/managed/realm-name_group/_id

GET

Returns the JSON representation of a specific group.

/openidm/managed/realm-name_group/_id?_fields=name,members

GET

Returns the relationships (members) associated with a group.

/openidm/managed/realm-name_group/_id/members?_queryFilter=true

GET

Lists the members of a group.

/openidm/managed/realm-name_group/_id

PUT

Creates a group with the specified ID.

/openidm/managed/realm-name_group/_id/members?_action=create

POST

Adds a member to a group.

/openidm/managed/realm-name_group/_id

PUT

Updates a group (replaces the entire object).

/openidm/managed/realm-name_group?_action=create

POST

Creates a new group. _id and name will be the same.

/openidm/managed/realm-name_group/_id

DELETE

Deletes a group.

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

Copyright © 2010-2023 ForgeRock, all rights reserved.