Spectra Logic

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

Add User as Group Member

Description

Add the specified user as a member of the specified group.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/group_member/?group_id={string}&member_user_id={string}

Request Parameters 

Parameter	Description	Required
group_id	The UUID, name, or other unique attribute of the group to which a member is being added. To determine the UUID for a group, see Get Groups.	yes
member_user_id	User UUID, name, or other unique attribute of the user to be added. To determine the UUID for a user, see Get Users.	yes

Responses

Response Elements

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

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
GroupId	The UUID for the group to which the user was added.
Id	The UUID for the membership of the user in the group.
MemberGroupId	Always null for this operation.
MemberUserId	The UUID for the user added to the group.

Example

Sample Request

This request adds the user “MJ” to the group named “Accounting”.

POST http[s]://blackpearl-hostname/_rest_/group_member/?group_id=Accounting&member_user_id=MJ HTTP/1.1

Sample Response

HTTP/1.1 201 OK
<Data>
   <GroupId>3962c577-5ddb-466f-bb56-a0c7e3019c81</GroupId>
   <Id>96dd02c6-4690-435f-8a7a-a9754b772b6d</Id>
   <MemberGroupId/>
   <MemberUserId>
      2aea0681-e80b-4d9d-9119-d6653a00cbed
   </MemberUserId>
</Data>