Versión: 4.42

Referencia de la API — Gestión de usuarios locales

Descripción general

La API de administración de Redtrust incluye métodos para gestionar el ciclo de vida completo de los usuarios locales: crearlos, actualizarlos, cambiar su estado, desbloquearlos y eliminarlos.

Antes de empezar

Antes de probar estos métodos, necesitas configurar SoapUI.

important

Los comentarios  que aparecen en las solicitudes SOAP se generan automáticamente y pueden marcar de forma incorrecta campos obligatorios como opcionales.

Esta documentación indica explícitamente qué campos son obligatorios u opcionales. Confía siempre en esta documentación.

Crea un usuario local

`AddLocalUser`

Crea un nuevo usuario local en un dominio.

Nombre	Tipo	Requerido	Descripción
`domainId`	integer	Sí	ID del dominio. Encuentra el valor en `ListDomains`.
`username`	string	Sí	Nombre de usuario. Acepta letras (A-Z, a-z), números (0-9) y los caracteres `-`, `_` y `.` como separadores.
`name`	string	Sí	Nombre completo del usuario. Puede incluir espacios y caracteres acentuados.
`password`	string	Sí	Contraseña de al menos 3 caracteres. Se permite cualquier carácter.
`email`	string	Sí	Debe tener un formato de correo electrónico válido.
`forceChangePassword`	boolean	Sí	Obliga al usuario a cambiar la contraseña la primera vez que se autentique en Redtrust.
`active`	boolean	Sí	Indica si la cuenta del usuario está activa. Si es `true`, el usuario puede iniciar sesión; si es `false`, la cuenta está deshabilitada.

Petición
Respuesta

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

El campo ResultData contiene el ID del nuevo usuario.

Actualiza un usuario local

`EditLocalUser`

Actualiza un usuario local existente. Los campos que no se incluyan en la solicitud conservan su valor actual.

Nombre	Tipo	Requerido	Descripción
`domainId`	integer	Sí	ID del dominio donde existe el usuario. Encuentra el valor en `ListDomains`.
`userId`	integer	Sí	ID del usuario que quieres actualizar. Encuentra el valor en `ListDomainUserIds`.
`name`	string	No*	Nombre completo del usuario. Puede incluir espacios y caracteres acentuados.
`password`	string	No	Contraseña de al menos 3 caracteres. Se permite cualquier carácter. Para poder actualizarla, debes proporcionar `name` e `email`.
`email`	string	No*	Para poder actualizarlo, debes proporcionar `name`. Debe tener un formato de correo electrónico válido.
`forceChangePassword`	boolean	Sí	Obliga al usuario a cambiar la contraseña la primera vez que se autentique en Redtrust. Para poder actualizarlo, debes proporcionar `name` e `email`.
`active`	boolean	Sí	Indica si la cuenta del usuario está activa (`true`) o deshabilitada (`false`). Para poder actualizarlo, debes proporcionar `name` e `email`.

(*) Requerido para actualizar algunos parámetros.

Petición
Respuesta

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

Habilita o deshabilita usuarios

`ChangeUsersStatus`

Cambia el estado activo o inactivo de uno o más usuarios a la vez.

Nombre	Tipo	Requerido	Descripción
`domainId`	integer	Sí	ID del dominio. Encuentra el valor en `ListDomains`.
`userIds`	array de enteros	Sí	IDs de los usuarios que quieres actualizar. Encuentra los valores en `ListDomainUserIds`. Puedes enviar varios IDs tal como se muestra en el ejemplo.
`status`	integer	Sí	Estado que quieres aplicar: activo (`1`) o inactivo (`0`).

Petición
Respuesta

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

Desbloquea un usuario local

`UnblockLocalUser`

Desbloquea un usuario local que ha quedado bloqueado tras varios intentos de autenticación fallidos.

Nombre	Tipo	Requerido	Descripción
`domainId`	integer	Sí	ID del dominio donde existe el usuario. Encuentra el valor en `ListDomains`.
`userId`	integer	Sí	ID del usuario que quieres desbloquear. Encuentra el valor en `ListDomainUserIds`.

Petición
Respuesta

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

El campo ResultData indica el estado de bloqueo del usuario tras la operación. false significa que el usuario está desbloqueado.

Elimina usuarios

`DeleteUsers`

Elimina uno o más usuarios de forma permanente.

Nombre	Tipo	Requerido	Descripción
`domainId`	integer	Sí	ID del dominio donde existe el usuario. Encuentra el valor en `ListDomains`.
`userIds`	array de enteros	Sí	IDs de los usuarios que quieres eliminar. Encuentra los valores en `ListDomainUserIds`. Puedes enviar varios IDs tal como se muestra en el ejemplo.

Petición
Respuesta

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

Consulta información de usuarios

`ListUsersInDomain`

Devuelve la lista de usuarios de un dominio con sus datos principales.

Nombre	Tipo	Requerido	Descripción
`domainId`	integer	Sí	ID del dominio. Encuentra el valor en `ListDomains`.
`filter`	string	No	Texto que deben contener los resultados. Si está vacío, devuelve todos los usuarios.

Petición
Respuesta

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

Consulta la referencia completa de los campos de UserView en Objetos de respuesta.

`ListDomains`

Devuelve la lista de dominios disponibles. Usa este método para obtener el valor de domainId.

Nombre	Tipo	Requerido	Descripción
`filter`	string	No	Texto que deben contener los resultados. Si está vacío, devuelve todos los dominios.

Petición
Respuesta

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

Consulta la referencia completa de los campos de DomainView en Objetos de respuesta.

`ListDomainUserIds`

Devuelve la lista de IDs de usuario de un dominio. Usa este método para obtener el valor de userId o userIds.

Nombre	Tipo	Requerido	Descripción
`domainId`	integer	Sí	ID del dominio. Encuentra el valor en `ListDomains`.
`viewType`	string	Sí	Filtra los usuarios por estado: `VIEW_ALL`, `VIEW_ACTIVE`, `VIEW_INACTIVE`, `VIEW_CONSUME_LICENSE`, `VIEW_NO_CONSUME_LICENSE`.
`filter`	string	No	Texto que deben contener los resultados. Si está vacío, devuelve todos los usuarios.

Petición
Respuesta

<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">The operation has been successfully completed.</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>

Descripción general​

Antes de empezar​

Crea un usuario local​

AddLocalUser​

Actualiza un usuario local​

EditLocalUser​

Habilita o deshabilita usuarios​

ChangeUsersStatus​

Desbloquea un usuario local​

UnblockLocalUser​

Elimina usuarios​

DeleteUsers​

Consulta información de usuarios​

ListUsersInDomain​

ListDomains​

ListDomainUserIds​