Group Membership

Load members of a group

Members is actually a reference field on every Group content allowed to contain multiple references, so the users and groups can be added as members just like another referred content with their ids. Using the following code snippet you can expand the content of the Members field of a group and get the members' usernames.


Add members to a group

Users with appropriate permissions allowed can add new members to a group. The list of new members can be provided using the contentIds parameter (list of user or group ids). In the following example you can see how you can add users businesscat and editormanatee as members of the public developers group:

url: "/OData.svc/Root/IMS/Public('developers')/AddMembers",
type: 'POST',
data: "models=[" + JSON.stringify({
    'contentIds': [ 1155, 1157 ]
  }) + "]",

Remove members from a group

Users with the appropriate permissions allowed are also able to remove members from a group using. The list of members to be deleted should be provided in the contentIds parameter as list of user or group ids.

url: "/OData.svc/Root/IMS/Public('developers')/RemoveMembers",
type: 'POST',
data: "models=[" + JSON.stringify({
    'contentIds': [ 1157 ]
  }) + "]",

Get all group memberships (roles) of a user

With using following example you can get the list of all the groups where the given user is a member. Since groups can be also members of other groups this means that the list will contain both the direct and the inherited memberships. The list is available as the value of a special field on the type User which means you work with it a the same way as you use fields in general.


Get the list of groups where the user is directly added as a member

The list above contains all the group memberships without filtering out the indirect ones and the following examples show you how you can get only those ones where the given user is a direct member (added as a referenced content in the groups' Members field). Following solution is based on a special field as well like the one above.


Get the list of workspaces where the given user is member

It is a common use case to list the workspaces that are related to a user. The closest workspace is stored on every content as a reference, so you get the required info with simply expanding the Workspace field. Following example shows you how to get the list of workspaces where the given user is a member of a local group.

url: "/OData.svc/Root/Content?query=%2BType%3AGroup %2BMembers%3A{{Id%3A1163}} .AUTOFILTERS%3AOFF&$select=Workspace/DisplayName&$expand=Workspace",
type: 'GET',

// the special characters should be url encoded
// the actual query here is ?query=+Type:Group +Members:{{Id:1163}} .AUTOFILTERS:OFF&$select=Workspace/DisplayName&$expand=Workspace"