removeGroupMembers

Removes company users from a specific group.

Differences Between Remove Commands

  • removeGroupMembers: Removes multiple users from a group.
  • removeGroupMembership: Removes an individual user from an array of groups.

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (removeGroupMembersParam)

Name Type Required Description
*companyHandle* xsd:string Yes The handle to the company with the users you want to work with.
*groupHandle* xsd:string Yes Group handle.
*userHandleArray* types:HandleArray Yes An array of handles for users whose group memberships you want to remove.

Output (removeGroupMembersParam)

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

Examples

This code sample removes a user from the specified company. Remove multiple users from a group with the user handle array.

Request

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

Response

None.

On this page

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now