Developer Group Management

The GroupDataService provides operations to manage groups as well as determine which users are associated with a group. The operations below can be found on the GroupDataSerivce.

Service Operations

Operation Name: addGroup(Group group)

Parameters:

• Group group

Return:

• GroupResponse

Operation adds a new Group and related attributes into the OpenIAM repository as part of a single transaction. The returned group, which is found in the GroupResponse object will contain the Group ID that is generated by the system.

Groups are hierarchical. To create a child group, provide the id of a parent group in the parentGrpId element in the request shown below.

Sample Request:

Sample Response:

Operation Name: addUserToGroup(String groupId, String userId);

Parameters:

• String groupId
• String userId

Return:

• Response

Associates a user to a group. You must create both the user and the group before this association can be made.

Sample Request:

Operation Name: getGroup(String groupId)

Parameters:

• String groupId

Return:

• GroupResponse

Returns the group object that is specified by the groupId parameter. If the group is not found, then that status indicator in the response object will be set to FAILURE.

Sample Request:

Sample Response:

Operation Name: getChildGroup(String parentGroupId, boolean subgroups)

Parameters:

• String parentGroupId
• boolean subGroups

Return:

• GroupListResponse

Returns a list of child Group object are immediate decendants of the parent group that is specified by the parentGroupId. If the subGroups flag is set to true, then the operation will retrieve any child groups which are nested deeper in the hierarchy.

The sample request and response below shows a response that contains a nested child group relationship.

Sample Request:

Sample Response:

Operation Name: getUserInGroups(String userId)

Parameters:

• String userId

Return:

• GroupListResponse

Returns List of Groups that a user belongs to. Since groups can be hierarchical, its possible that additional groups will be found in the subGroups property. This operation will traverse the group hierarchy from the bottom up to return the list of groups a user belongs to.

Sample Request:

Operation Name: getUserInGroupsAsFlatList(String userId)

Parameters:

• String userId

Return:

• GroupListResponse

Returns List of Groups that a user belongs to. The list of Groups is returns a flat list. This operation will traverse the group hierarchy from the bottom up to return the list of groups a user belongs to.

Sample Request:

Operation Name: isUserInGroup(String groupId, String userId)

Parameters:

• String groupId
• String userId

Return:

• Response

Determines if the user is associated with groupId.

Sample Request: