Scheduled Maintenance: Experience League will be undergoing maintenance on July 31 from 6:00–8:00 AM PT. We apologize for any inconvenience or disruption this may cause.

DocumentationDynamic Media Image Production System API

getUsers

Last update: March 8, 2022
  • Topics:
  • Dynamic Media Classic,SDK/API

CREATED FOR:

  • Developer
  • Admin

Gets an array of users as specified by company, group, and user role handles. This operation lets you sort returned users and filter by character.

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
NameTypeRequiredDescription
includeInactivexsd:booleanNoInclude or exclude inactive users. Non-IPS Admin users must be an active member of at least one company to be authorized to make any API calls. An authorization fault is returned if the user has no active company memberships.
includeInvalidxsd:booleanNoLets you include/exclude invalid users.
companyHandleArraytypes:HandleArrayNoFilter results by company.
groupHandleArraytypes:HandleArrayNoFilter results by group.
userRoleArraytypes:StringArrayNoFilter results by user role.
charFilterFieldxsd:stringNoFilter results by field’s string prefix (see Trash State).
charFilterxsd:stringNoFilter results by a specific character.
sortByxsd:stringNoChoice of user sort fields.
recordsPerPagexsd:intNoReturns specified number of records per page.
resultsPagexsd:intNoResults page.

Output (getUsersReturn)

NameTypeRequiredDescription
userArraytypes:UserArrayYesAn array of users.

Examples

This code sample returns the array of users for several optional parameters. User roles, user character filter fields, and user sort fields are determined by using specific String Constants.

Request

<ns1:getUsersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:includeInvalid>false</ns1:includeInvalid>
   <ns1:companyHandleArray>
      <ns1:items>47</ns1:items>
   </ns1:companyHandleArray>
   <ns1:userRoleArray>
      <ns1:items>IpsAdmin</ns1:items>
   </ns1:userRoleArray>
   <ns1:sortBy>LastName</ns1:sortBy>
</ns1:getUsersParam>

Response

<getUsersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <userArray>
      <items>
         <userHandle>70|kmagnusson@adobe.com</userHandle>
         <firstName>Kris</firstName>
         <lastName>Magnusson</lastName>
         <email>kmagnusson@adobe.com</email>
         <role>IpsAdmin</role>
         <isValid>true</isValid>
         <passwordExpires>2107-07-27T15:18:15.816-07:00</passwordExpires>
      </items>
      ...
   </userArray>
</getUsersReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681