getUsers

Obtiene una matriz de usuarios según lo especificado por los controladores de empresa, grupo y función de usuario. Esta operación permite ordenar los usuarios devueltos y filtrar por carácter.

Tipos de usuarios autorizados

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
Nombre Tipo Obligatorio Descripción
*includeInactive* xsd:boolean No Incluir o excluir usuarios inactivos. Los usuarios administradores que no sean de IPS deben ser miembros activos de al menos una empresa para poder realizar llamadas de API. Se devolverá un error de autorización si el usuario no tiene miembros activos de la empresa.
*includeInvalid* xsd:boolean No Permite incluir o excluir usuarios no válidos.
*companyHandleArray* types:HandleArray No Filtrar resultados por empresa.
*groupHandleArray* types:HandleArray No Filtrar resultados por grupo.
*userRoleArray* types:StringArray No Filtre los resultados por función de usuario.
*charFilterField* xsd:string No Filtrar los resultados por el prefijo de cadena del campo (consulte Trash State).
*charFilter* xsd:string No Filtre los resultados por un carácter específico.
*sortBy* xsd:string No Selección de campos de ordenación por el usuario.
*recordsPerPage* xsd:int No Devuelve el número especificado de registros por página.
*resultsPage* xsd:int No Resultados .

Salida (getUsersReturn)

Nombre Tipo Obligatorio Descripción
*userArray* types:UserArray Sí Una matriz de usuarios.

Ejemplos

Este ejemplo de código devuelve la matriz de usuarios para varios parámetros opcionales. Las funciones de usuario, los campos de filtro de caracteres de usuario y los campos de ordenación de usuario se determinan mediante el uso de constantes de cadena específicas.

Solicitar

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

Respuesta

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

En esta página