Show Menu
TOPICS×

setGroupMembership

Sets group membership for a user.
Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (setGroupMembershipParam)
Name
Type
Required
Description
* userHandle *
xsd:string
No
The handle to the user whose group membership you want to set.
* companyHandle *
xsd:string
No
Company handle.
* groupHandleArray *
types:HandleArray
Yes
The array of handles to groups to which the user to belongs.
Output (setGroupMembershipReturn)
The IPS API does not return a response for this operation.

Examples

This code sample makes the user a member of a group. Add a user to multiple groups with the group handle array.
Request
<ns1:setGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:userHandle>70|kmagnusson@adobe.com</ns1:userHandle>
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:groupHandleArray>
      <ns1:items>225</ns1:items>
   </ns1:groupHandleArray>
</ns1:setGroupMembershipParam>

Response
None.