DocumentationAEMAPI du système d’exploitation d’images Dynamic Media

getUsers getusers

Dernière mise à jour : 15 mai 2026

Créé pour :

  • Developer
  • Admin

Obtient un tableau d’utilisateurs tel que spécifié par les descripteurs de rôle d’entreprise, de groupe et d’utilisateur. Cette opération vous permet de trier les utilisateurs renvoyés et de filtrer par caractère.

Types d’utilisateurs autorisés section-6a8f23cc6b22442d8776f701016971ed

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
Nom
Type
Obligatoire
Description
includeInactive
xsd:boolean
Non
Incluez ou excluez les utilisateurs inactifs. Les utilisateurs administrateurs non-IPS doivent être membres actifs d’au moins une société pour être autorisés à effectuer des appels API. Une erreur d’autorisation est renvoyée si l’utilisateur n’a pas d’adhésions d’entreprise actives.
includeInvalid
xsd:boolean
Non
Permet d’inclure ou d’exclure des utilisateurs non valides.
companyHandleArray
types:HandleArray
Non
Filtrez les résultats par entreprise.
groupHandleArray
types:HandleArray
Non
Filtrez les résultats par groupe.
userRoleArray
types:StringArray
Non
Filtrez les résultats par rôle d’utilisateur.
charFilterField
xsd:string
Non
Filtrer les résultats en fonction du préfixe de chaîne du champ (voir Trash State).
charFilter
xsd:string
Non
Filtrez les résultats selon un caractère spécifique.
sortBy
xsd:string
Non
Choix des champs de tri des utilisateurs.
recordsPerPage
xsd:int
Non
Retourne le nombre spécifié d’enregistrements par page.
resultsPage
xsd:int
Non
Page de résultats.

Output (getUsersReturn)

Nom
Type
Obligatoire
Description
userArray
types:UserArray
Oui
Tableau d’utilisateurs.

Exemples section-bc43a5dd7b4c4f048d25fc881554dab2

Cet exemple de code renvoie le tableau des utilisateurs pour plusieurs paramètres facultatifs. Les rôles utilisateur, les champs de filtre de caractères utilisateur et les champs de tri utilisateur sont déterminés à l’aide de constantes de chaîne spécifiques.

Requête

<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>

Réponse

<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
dynamic-media-developer-resources-help-aem-ips-api