DocumentationDynamic Media Image Production System API

removeGroupMembership

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Removes users from an array of groups.

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 (removeGroupMembershipParam)

Name
Type
Required
Description
userHandle
xsd:string
No
The handle to the company whose group membership you want to remove.
groupHandleArray
types:HandleArray
Yes
The array of handles to groups from which you want the company to be removed.

Output (removeGroupMembershipReturn)

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

Examples

This code sample removes a user from a group.

Request

<ns1:removeGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:userHandle>47</ns1:userHandle>
   <ns1:groupHandleArray>
      <ns1:items>225</ns1:items>
   </ns1:groupHandleArray>
</ns1:removeGroupMembershipParam>

Response

None.

4e9b9d8c-5839-4215-aa35-01b652869681