Version: 4.42

Referência da API — Gerenciamento de usuários locais

Visão geral

A API de administração do Redtrust inclui métodos para gerenciar o ciclo de vida completo dos usuários locais: criá-los, atualizá-los, alterar seu status, desbloqueá-los e excluí-los.

Antes de começar

Antes de testar esses métodos, você precisa configurar o SoapUI.

important

Os comentários  exibidos nas solicitações SOAP são gerados automaticamente e podem marcar incorretamente campos obrigatórios como opcionais.

Esta documentação indica explicitamente quais campos são obrigatórios ou opcionais. Sempre confie nesta documentação.

Criar usuário local

`AddLocalUser`

Cria um novo usuário local em um domínio.

Nome	Tipo	Obrigatório	Descrição
`domainId`	integer	Sim	ID do domínio. Localize o valor em `ListDomains`.
`username`	string	Sim	Nome de usuário. Aceita letras (A-Z, a-z), números (0-9) e os caracteres `-`, `_` e `.` como separadores.
`name`	string	Sim	Nome completo do usuário. Pode incluir espaços e caracteres acentuados.
`password`	string	Sim	Senha com pelo menos 3 caracteres. Qualquer caractere é permitido.
`email`	string	Sim	Deve estar em um formato de e-mail válido.
`forceChangePassword`	boolean	Sim	Obriga o usuário a alterar a senha na primeira vez que se autenticar no Redtrust.
`active`	boolean	Sim	Indica se a conta do usuário está ativa. Se `true`, o usuário pode fazer login; se `false`, a conta fica desativada.

Requisição
Resposta

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:AddLocalUser>
            <urn:domainId>1</urn:domainId>
            <urn:username>maria.lopez</urn:username>
            <urn:name>maria</urn:name>
            <urn:password>123maria</urn:password>
            <urn:email>maria@test.com</urn:email>
            <urn:forceChangePassword>0</urn:forceChangePassword>
            <urn:active>1</urn:active>
        </urn:AddLocalUser>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/AddLocalUserResponse</a:Action>
    </s:Header>
    <s:Body>
        <AddLocalUserResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="c:int" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">1007</ResultData>
            </Result>
        </AddLocalUserResponse>
    </s:Body>
</s:Envelope>

O campo ResultData contém o ID do novo usuário.

Atualizar usuário local

`EditLocalUser`

Atualiza um usuário local existente. Os campos não incluídos na solicitação mantêm seu valor atual.

Nome	Tipo	Obrigatório	Descrição
`domainId`	integer	Sim	ID do domínio onde o usuário está localizado. Localize o valor em `ListDomains`.
`userId`	integer	Sim	ID do usuário que você deseja atualizar. Localize o valor em `ListDomainUserIds`.
`name`	string	Não*	Nome completo do usuário. Pode incluir espaços e caracteres acentuados.
`password`	string	Não	Senha com pelo menos 3 caracteres. Qualquer caractere é permitido. Para atualizá-la, você deve fornecer o `name` e o `email`.
`email`	string	Não*	Para atualizá-lo, você deve fornecer o `name`. Deve estar em um formato de e-mail válido.
`forceChangePassword`	boolean	Sim	Obriga o usuário a alterar a senha na primeira vez que se autenticar no Redtrust. Para atualizá-lo, você deve fornecer o `name` e o `email`.
`active`	boolean	Sim	Indica se a conta do usuário está ativa (`true`) ou desativada (`false`). Para atualizá-lo, você deve fornecer o `name` e o `email`.

(*) Necessário para atualizar alguns parâmetros.

Requisição
Resposta

   <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
      <soap:Header/>
      <soap:Body>
         <urn:EditLocalUser>
            <urn:domainId>1</urn:domainId>
            <urn:userId>2</urn:userId>
            <urn:name>Betty Smith</urn:name>
            <urn:password></urn:password>
            <urn:email></urn:email>
            <urn:forceChangePassword>0</urn:forceChangePassword>
            <urn:active>1</urn:active>
         </urn:EditLocalUser>
      </soap:Body>
   </soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/EditLocalUserResponse</a:Action>
   </s:Header>
   <s:Body>
      <EditLocalUserResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
         </Result>
      </EditLocalUserResponse>
   </s:Body>
</s:Envelope>

Ativar ou desativar usuários

`ChangeUsersStatus`

Altera o status ativo ou inativo de um ou mais usuários ao mesmo tempo.

Nome	Tipo	Obrigatório	Descrição
`domainId`	integer	Sim	ID do domínio. Localize o valor em `ListDomains`.
`userIds`	array de inteiros	Sim	IDs dos usuários a serem atualizados. Localize os valores em `ListDomainUserIds`. Você pode enviar vários IDs conforme mostrado no exemplo.
`status`	integer	Sim	Status a aplicar: ativo (`1`) ou inativo (`0`).

Requisição
Resposta

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soap:Header/>
   <soap:Body>
      <urn:ChangeUsersStatus>
         <urn:domainId>1</urn:domainId>
         <urn:userIds>
            <!--Zero or more repetitions:-->
            <arr:int>1011</arr:int>
            <arr:int>1012</arr:int>
            <arr:int>1013</arr:int>
         </urn:userIds>
         <urn:status>1</urn:status>
      </urn:ChangeUsersStatus>
   </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ChangeUsersStatusResponse</a:Action>
   </s:Header>
   <s:Body>
      <ChangeUsersStatusResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
         </Result>
      </ChangeUsersStatusResponse>
   </s:Body>
</s:Envelope>

Desbloquear usuário local

`UnblockLocalUser`

Desbloqueia um usuário local que foi bloqueado após várias tentativas de autenticação malsucedidas.

Nome	Tipo	Obrigatório	Descrição
`domainId`	integer	Sim	ID do domínio onde o usuário está localizado. Localize o valor em `ListDomains`.
`userId`	integer	Sim	ID do usuário a ser desbloqueado. Localize o valor em `ListDomainUserIds`.

Requisição
Resposta

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:UnblockLocalUser>
            <urn:domainId>1</urn:domainId>
            <urn:userId>1007</urn:userId>
        </urn:UnblockLocalUser>
    </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
    <s:Header>
        <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/UnblockLocalUserResponse</a:Action>
    </s:Header>
    <s:Body>
        <UnblockLocalUserResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
                <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
                <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
                <ResultData i:type="c:boolean" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://www.w3.org/2001/XMLSchema">false</ResultData>
                <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
            </Result>
        </UnblockLocalUserResponse>
    </s:Body>
</s:Envelope>

O campo ResultData indica o estado de bloqueio do usuário após a operação. false significa que o usuário está desbloqueado.

Excluir usuários

`DeleteUsers`

Exclui um ou mais usuários de forma permanente.

Nome	Tipo	Obrigatório	Descrição
`domainId`	integer	Sim	ID do domínio onde o usuário está localizado. Localize o valor em `ListDomains`.
`userIds`	array de inteiros	Sim	IDs dos usuários a serem excluídos. Localize os valores em `ListDomainUserIds`. Você pode enviar vários IDs conforme mostrado no exemplo.

Requisição
Resposta

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soap:Header/>
   <soap:Body>
      <urn:DeleteUsers>
         <urn:domainId>1</urn:domainId>
         <urn:userIds>
            <!--Zero or more repetitions:-->
            <arr:int>1006</arr:int>
            <arr:int>1010</arr:int>
         </urn:userIds>
      </urn:DeleteUsers>
   </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/DeleteUsersResponse</a:Action>
   </s:Header>
   <s:Body>
      <DeleteUsersResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Operation finalized successfully</ResultMessage>
         </Result>
      </DeleteUsersResponse>
   </s:Body>
</s:Envelope>

Consultar informações de usuários

`ListUsersInDomain`

Retorna a lista de usuários de um domínio com seus dados principais.

Nome	Tipo	Obrigatório	Descrição
`domainId`	integer	Sim	ID do domínio. Localize o valor em `ListDomains`.
`filter`	string	Não	Quando estiver vazio, lista todos os usuários. Como alternativa, adicione o nome de usuário ou o e-mail para filtrar os resultados.

Requisição
Resposta

   <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
      <soap:Header/>
      <soap:Body>
         <urn:ListUsersInDomain>
            <urn:filter>john</urn:filter>
            <urn:domainId>1</urn:domainId>
         </urn:ListUsersInDomain>
      </soap:Body>
   </soap:Envelope>

   <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
      <s:Header>
         <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListUsersInDomainResponse</a:Action>
      </s:Header>
      <s:Body>
         <ListUsersInDomainResponse xmlns="urn:evolium:redtrust:administration:ws">
            <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
               <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
               <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
               <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">The operation has been successfully completed.</ResultMessage>
               <ResultData i:type="b:ArrayOfUserView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
                  <b:UserView>
                     <b:consumeLicense>false</b:consumeLicense>
                     <b:domain>local.users</b:domain>
                     <b:email>john@test.com</b:email>
                     <b:friendlyName>john</b:friendlyName>
                     <b:groupType>USER</b:groupType>
                     <b:lastCertificateUsage i:nil="true"/>
                     <b:passwordExpirationDate i:nil="true"/>
                     <b:status>true</b:status>
                     <b:type>LOCAL_USER</b:type>
                     <b:uid>USER:1007@local.users</b:uid>
                     <b:userHandler>1007</b:userHandler>
                     <b:username>john.smith</b:username>
                  </b:UserView>
               </ResultData>
               <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
            </Result>
         </ListUsersInDomainResponse>
      </s:Body>
   </s:Envelope>

Consulte a referência completa dos campos de UserView em Objetos de resposta.

`ListDomains`

Retorna a lista de domínios disponíveis. Use este método para obter o valor de domainId.

Nome	Tipo	Obrigatório	Descrição
`filter`	string	Não	Quando estiver vazio, lista todos os domínios. Como alternativa, adicione o nome do domínio para o qual você precisa do ID.

Requisição
Resposta

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
   <soap:Header/>
   <soap:Body>
      <urn:ListDomains>
         <urn:filter>local.users</urn:filter>
      </urn:ListDomains>
   </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListDomainsResponse</a:Action>
   </s:Header>
   <s:Body>
      <ListDomainsResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">The operation has been successfully completed.</ResultMessage>
            <ResultData i:type="b:ArrayOfDomainView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
               <b:DomainView>
                  <b:alias>local.users</b:alias>
                  <b:allowPersonalArea>false</b:allowPersonalArea>
                  <b:allowUploadCerts>false</b:allowUploadCerts>
                  <b:allowedUsers>0</b:allowedUsers>
                  <b:domainPartners xmlns:c="http://schemas.datacontract.org/2004/07/RTCommonModels.Enums"/>
                  <b:id>1</b:id>
                  <b:isExternal>false</b:isExternal>
                  <b:numUsers>5</b:numUsers>
                  <b:schema>LOCAL_USER</b:schema>
                  <b:sharepointAccess>false</b:sharepointAccess>
                  <b:webSignatureAccess>false</b:webSignatureAccess>
               </b:DomainView>
            </ResultData>
            <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
         </Result>
      </ListDomainsResponse>
   </s:Body>
</s:Envelope>

Consulte a referência completa dos campos de DomainView em Objetos de resposta.

`ListDomainUserIds`

Retorna a lista de IDs de usuário de um domínio. Use este método para obter o valor de userId ou userIds.

Nome	Tipo	Obrigatório	Descrição
`domainId`	integer	Sim	ID do domínio. Localize o valor em `ListDomains`.
`viewType`	string	Sim	Filtra os usuários por status: `VIEW_ALL`, `VIEW_ACTIVE`, `VIEW_INACTIVE`, `VIEW_CONSUME_LICENSE`, `VIEW_NO_CONSUME_LICENSE`.
`filter`	string	Não	Quando estiver vazio, lista todos os usuários. Como alternativa, adicione o nome de usuário para o qual você precisa do ID.

Requisição
Resposta

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
   <soap:Header/>
   <soap:Body>
      <urn:ListDomainUserIds>
         <urn:domainId>1</urn:domainId>
         <urn:viewType>VIEW_ALL</urn:viewType>
         <urn:filter></urn:filter>
      </urn:ListDomainUserIds>
   </soap:Body>
</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">urn:evolium:redtrust:administration:ws/RTAdminService/ListDomainUserIdsResponse</a:Action>
   </s:Header>
   <s:Body>
      <ListDomainUserIdsResponse xmlns="urn:evolium:redtrust:administration:ws">
         <Result xmlns:b="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResultStatus xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">SUCCESS</ResultStatus>
            <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">OK</ErrorCode>
            <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">A operação foi concluída com sucesso.</ResultMessage>
            <ResultData i:type="c:ArrayOfint" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
               <c:int>2</c:int>
               <c:int>1005</c:int>
               <c:int>1006</c:int>
               <c:int>1007</c:int>
            </ResultData>
            <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">4</TotalItems>
         </Result>
      </ListDomainUserIdsResponse>
   </s:Body>
</s:Envelope>

Visão geral​

Antes de começar​

Criar usuário local​

AddLocalUser​

Atualizar usuário local​

EditLocalUser​

Ativar ou desativar usuários​

ChangeUsersStatus​

Desbloquear usuário local​

UnblockLocalUser​

Excluir usuários​

DeleteUsers​

Consultar informações de usuários​

ListUsersInDomain​

ListDomains​

ListDomainUserIds​