DocumentationDynamic Media Image Production System API

removeCompanyMembership

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

CREATED FOR:

  • Developer
  • Admin

Removes a user from one or more companies.

Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (removeCompanyMembershipParam)

Name
Type
Required
Description
userHandle
xsd:string
No
The handle to the user with the membership you want to remove.
companyHandleArray
types:HandleArray
Yes
The handle to the company that you’re removing the user from.

Output (removeCompanyMembershipReturn)

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

Examples

This code sample removes a user from a company. Omit the optional user handle to remove all users from the companies specified in the company handle array.

Request

<ns1:removeCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:userHandle>621|jduvar@adobe.com</ns1:userHandle>
   <ns1:companyHandleArray>
      <ns1:items>47</ns1:items>
   </ns1:companyHandleArray>
</ns1:removeCompanyMembershipParam>

Response

None.

4e9b9d8c-5839-4215-aa35-01b652869681