DocumentationDynamic Media Image Production System API

getCompanyMembers getcompanymembers

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

CREATED FOR:

  • Developer
  • Admin

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

Syntax

Authorized User Types section-b2bc2fa0cc944cea8be82524838307cc

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters section-5602e4d6f2214e398e6a804e61f1a088

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 section-39d8cf3653fd4fe8b842caabac9dedfc

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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681