setGroupMembers

Sets the group membership of users that belong to a specific company.

The operation throws an authentication fault if you do not have privileges to accomplish this operation. This is also true if any of the users in the user handle array do not belong to the company specified in the company handle,

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (setGroupMembersParam)

Name Type Required Description
*companyHandle* xsd:string Yes Company handle.
*groupHandle* xsd:string Yes Group handle.
*userHandleArray* types:HandleArray Yes Array of handles for users whose group membership you want to set.

Output (setGroupMembesReturn)

The IPS API does not return a response for this operation.

Examples

This code sample sets group membership for a single user.

Request

<ns1:setGroupMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:groupHandle>225</ns1:groupHandle>
   <ns1:userHandleArray>
      <ns1:items>70|kmagnusson@adobe.com</ns1:items>
   </ns1:userHandleArray>
</ns1:setGroupMembersParam>

Response

None.

On this page