getCompanyMembers

Last update: 2022-03-08
  • Created for:
  • Developer
    Admin

Returns the users of a company specified by a company handle.

Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (getCompanyMembersParam)

Name Type Required Description
companyHandle xsd:string Yes The handle to the company whose members you want to obtain.
includeInvalid xsd:boolean Yes Include invalid companies.

Output (getCompanyMembersReturn)

Name Type Required Description
memberArray types:CompanyMemberArray Yes Array of user memberships.

Examples

This code sample returns all the members of a company in a user array. The response has been truncated for brevity.

Request

<ns1:getCompanyMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:includeInvalid>false</ns1:includeInvalid>
</ns1:getCompanyMembersParam>

Response

<getCompanyMembersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <memberArray>
      <items>
         <userHandle>66|pbayol@adobe.com</userHandle>
         <firstName>Peter</firstName>
         <lastName>Bayol</lastName>
         <email>pbayol@adobe.com</email>
         <role>IpsAdmin</role>
         <isValid>true</isValid>
         <passwordExpires>2107-07-25T23:12:49.472-07:00</passwordExpires>
      </items>
      ...
   </memberArray>
</getCompanyMembersReturn>
Previous page
Next page

On this page