getUsers

Obtém uma matriz de usuários, conforme especificado por manipuladores de função de empresa, grupo e usuário. Essa operação permite classificar usuários retornados e filtrar por caractere.

Tipos de usuário autorizados

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
Nome Tipo Obrigatório Descrição
includeInative xsd:boolean Não Incluir ou excluir usuários inativos. Usuários não administrativos do IPS devem ser membros ativos de pelo menos uma empresa para serem autorizados a fazer chamadas de API. Uma falha de autorização é retornada se o usuário não tiver associações ativas à empresa.
includeInvalid xsd:boolean Não Permite incluir/excluir usuários inválidos.
companyHandleArray types:HandleArray Não Filtre os resultados por empresa.
groupHandleArray types:HandleArray Não Filtre os resultados por grupo.
userRoleArray types:StringArray Não Filtre os resultados por função de usuário.
charFilterField xsd:string Não Filtrar resultados por prefixo da string do campo (consulte Trash State).
charFilter xsd:string Não Filtre os resultados por um caractere específico.
sortBy xsd:string Não Escolha dos campos de classificação do usuário.
recordsPerPage xsd:int Não Retorna o número especificado de registros por página.
resultsPage xsd:int Não Página de resultados.

Saída (getUsersReturn)

Nome Tipo Obrigatório Descrição
userArray types:UserArray Sim Uma matriz de usuários.

Exemplos

Essa amostra de código retorna a matriz de usuários para vários parâmetros opcionais. As funções do usuário, os campos de filtro de caractere do usuário e os campos de classificação do usuário são determinados por meio de Constantes de string específicas.

Solicitação

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

Resposta

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

Nesta página