Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Group Members

Description

Get information about group members for all groups. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/group_member​[?group_id={string}][&last_page][&member_group_id={string}]​[&member_user_id={string}][&page_length={32‑bit integer}]​[&page_offset={32‑bit integer}][&page_start_marker={string}]

Request Parameters 

Parameter	Description	Required
group_id	The group UUID, name, or other unique attribute.	no
last_page	If included, only the last page of results is returned.	no
member_group_id	The UUID or other unique attribute of a group that is a member of another group. To determine the UUID for a group, see Get Groups.	no
member_user_id	User UUID or other unique attribute of a user within a group. To determine the UUID for a user, see Get Users.	no
page_length	The maximum number of group members to list. Default: all items after page_offset.	no
page_offset	The starting point for the first group member to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no

Responses

Response Elements

<Data>
   <GroupMember>
      <GroupId>{string}</GroupId>
      <Id>{string}</Id>
      <MemberGroupId>{string}</MemberGroupId>
      <MemberUserId>{string}</MemberUserId>
   </GroupMember>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
GroupMember	The container for information about one group member.
GroupId	The UUID for the group.
Id	The UUID for the group membership.
MemberGroupId	The UUID for the sub-group included in the larger group.
MemberUserId	The UUID for the user included in the group.

Example

Sample Request

This request gets information about all group members on the BlackPearl system.

GET http://blackpearl-hostname/_rest_/group_member/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <GroupMember>
      <GroupId>4a4efdf7-1540-4b79-b015-feb6ee6cb238</GroupId>
      <Id>3a81721c-ed32-4525-9f71-ab2c55f81942</Id>
      <MemberGroupId>
         94dedcfb-7520-4b11-8215-325bc27a2d9f
      </MemberGroupId>
      <MemberUserId/>
   </GroupMember>
   <GroupMember>
      <GroupId>4a4efdf7-1540-4b79-b015-feb6ee6cb238</GroupId>
      <Id>d9f2e9c1-5b66-4dd9-88ce-0216f5ffdc3a</Id>
      <MemberGroupId/>
      <MemberUserId>
         8f885fe0-87c7-427e-a82b-ad33df9d5a15
      </MemberUserId>
   </GroupMember>
   ...
</Data>