DocumentaçãoAPI do sistema de produção de imagens Dynamic Media

getUsers getusers

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor
  • Administrador

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

Tipos de usuário autorizados section-6a8f23cc6b22442d8776f701016971ed

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
Nome
Tipo
Obrigatório
Descrição
includeInative
xsd:boolean
Não
Incluir ou excluir usuários inativos. Os usuários não administradores de 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 da empresa.
includeInvalid
xsd:boolean
Não
Permite incluir/excluir usuários inválidos.
companyHandleArray
types:HandleArray
Não
Filtrar resultados por empresa.
groupHandleArray
types:HandleArray
Não
Filtrar resultados por grupo.
userRoleArray
types:StringArray
Não
Filtrar resultados por função de usuário.
charFilterField
xsd:string
Não
Filtrar resultados pelo prefixo da cadeia de caracteres do campo (consulte Trash State).
charFilter
xsd:string
Não
Filtrar resultados por um caractere específico.
sortBy
xsd:string
Não
Escolha de 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 section-bc43a5dd7b4c4f048d25fc881554dab2

Esta amostra de código retorna a matriz de usuários para vários parâmetros opcionais. Funções de usuário, campos de filtro de caracteres do usuário e campos de classificação do usuário são determinados com o uso 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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681