Saltar al contenido principal
Versión: 4.42

Referencia de la API — Gestión de certificados

Descripción general​

Los certificados son el recurso central de Redtrust. Esta documentación describe los métodos más relevantes para quienes necesiten gestionar el ciclo de vida de los certificados mediante la API: asignar usuarios a certificados, actualizar sus propiedades, cambiar su estado, eliminarlos y consultarlos.

Antes de empezar​

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

important

Los comentarios <!--Optional:--> 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.

Asigna un usuario a un certificado​

AddCertificateUser​

Crea un usuario de tipo certificado en un dominio. Este tipo de usuario se autentica en Redtrust mediante un certificado digital en lugar de un nombre de usuario y contraseña.

NombreTipoRequeridoDescripción
domainIdintegerSíID del dominio donde se crea el usuario. Encuentra el valor en ListDomains.
usernamestringSíNombre del usuario. Acepta letras (A-Z, a-z), números (0-9) y los caracteres -, _ y . como separadores.
namestringSíNombre completo del usuario.
emailstringSíCorreo electrónico del usuario. Debe tener un formato válido.
activebooleanSíIndica si la cuenta está activa (true) o deshabilitada (false).
issuerIdsarray de enterosNo*IDs de los certificados CA locales que deben aparecer en la cadena de certificación del certificado del usuario. Encuentra los valores en ListCACertificates usando certType=LOCAL_CA_ROOT.
certDirectiveIdsarray de enterosNo*IDs de las directivas de certificado que debe cumplir el certificado del usuario. Encuentra los valores en ListCertificateDirectives.
certAttributesarray de CertificateAttributeDataNo*Atributos de certificado que debe tener el certificado del usuario. Cada elemento incluye: id (tipo de atributo, de ListCertificateAttributes), name (nombre del atributo, de ListCertificateAttributes), type (operador de comparación: EXISTS, IS_EQUAL, NOT_EXISTS, NOT_EQUALS, CONTAINS) y value (el valor a comparar; no requerido para EXISTS y NOT_EXISTS).

(*) Debes proporcionar al menos uno de estos tres campos. Si omites los tres, el servidor devuelve un error.

<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" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types">
    <soap:Header/>
    <soap:Body>
        <urn:AddCertificateUser>
            <urn:domainId>2</urn:domainId>
            <urn:username>ana.garcia</urn:username>
            <urn:name>Ana García</urn:name>
            <urn:email>ana.garcia@example.com</urn:email>
            <urn:active>true</urn:active>
            <urn:issuerIds>
                <arr:int>5</arr:int>
            </urn:issuerIds>
            <urn:certDirectiveIds>
                <arr:int>1</arr:int>
            </urn:certDirectiveIds>
            <urn:certAttributes/>
        </urn:AddCertificateUser>
    </soap:Body>
</soap:Envelope>

EditCertificateUser​

Actualiza un usuario de tipo certificado existente en un dominio. Los campos de tipo array (issuerIds, certDirectiveIds, certAttributes) reemplazan los valores actuales por completo; omitir uno lo elimina.

NombreTipoRequeridoDescripción
domainIdintegerSíID del dominio donde existe el usuario. Encuentra el valor en ListDomains.
userIdintegerSíID del usuario de certificado que quieres actualizar. Es el valor devuelto en ResultData por AddCertificateUser.
namestringSíNombre completo del usuario.
emailstringSíCorreo electrónico del usuario. Debe tener un formato válido.
activebooleanSíIndica si la cuenta está activa (true) o deshabilitada (false).
issuerIdsarray de enterosNo*IDs de los certificados CA locales que deben aparecer en la cadena de certificación del certificado del usuario. Encuentra los valores en ListCACertificates usando certType=LOCAL_CA_ROOT.
certDirectiveIdsarray de enterosNo*IDs de las directivas de certificado que debe cumplir el certificado del usuario. Encuentra los valores en ListCertificateDirectives.
certAttributesarray de CertificateAttributeDataNo*Atributos de certificado que debe tener el certificado del usuario. Misma estructura que en AddCertificateUser.

(*) Debes proporcionar al menos uno de estos tres campos. Si omites los tres, el servidor devuelve un error.

<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:EditCertificateUser>
            <urn:domainId>2</urn:domainId>
            <urn:userId>42</urn:userId>
            <urn:name>Ana García</urn:name>
            <urn:email>ana.garcia@example.com</urn:email>
            <urn:active>true</urn:active>
            <urn:issuerIds>
                <arr:int>5</arr:int>
            </urn:issuerIds>
            <urn:certDirectiveIds>
                <arr:int>1</arr:int>
            </urn:certDirectiveIds>
            <urn:certAttributes/>
        </urn:EditCertificateUser>
    </soap:Body>
</soap:Envelope>

Actualiza un certificado​

EditCertificate​

Actualiza las propiedades locales de un certificado. La mayoría de los campos son operaciones de escritura: el valor que envías reemplaza el valor actual, por lo que debes enviar el estado completo deseado en cada solicitud, no solo los campos que quieres cambiar. Las excepciones se describen en la tabla.

NombreTipoRequeridoDescripción
certIdintegerSíID del certificado que quieres actualizar. Encuentra el valor en el campo certificateHandler devuelto por ListCertificates.
aliasstringNoNombre descriptivo del certificado visible en la consola. Si envías un valor vacío, se elimina el alias actual.
commentstringNoComentario libre sobre el certificado. Si envías un valor vacío, se elimina el comentario actual.
requirePinbooleanSíIndica si el certificado requiere PIN para usarse. Envía false para eliminar el PIN actual.
pinstringNoNuevo PIN del certificado. Envía vacío o nulo para mantener el PIN actual. Solo envía este parámetro cuando quieras cambiarlo.
requireUsageReasonbooleanSíIndica si el certificado requiere que el usuario introduzca un motivo de uso.
activebooleanSíIndica si el certificado está activo (true) o deshabilitado (false).
ownerUIDstringNoUID del propietario del certificado. Envía una cadena vacía para eliminar el propietario actual. Envía nulo para mantener el propietario actual.
userPinPolicyCertificateUserPinPolicySíPolítica de PIN de usuario: NO_USER_PIN, ASK_USER_PIN, FORCE_ASK_USER_PIN.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:EditCertificate>
            <urn:certId>14</urn:certId>
            <urn:alias>Certificado de firma - Contabilidad</urn:alias>
            <urn:comment>Renovado en marzo 2026</urn:comment>
            <urn:requirePin>false</urn:requirePin>
            <urn:pin></urn:pin>
            <urn:requireUsageReason>false</urn:requireUsageReason>
            <urn:active>true</urn:active>
            <urn:ownerUID></urn:ownerUID>
            <urn:userPinPolicy>NO_USER_PIN</urn:userPinPolicy>
        </urn:EditCertificate>
    </soap:Body>
</soap:Envelope>

Restablece el PIN de un certificado​

ResetPin​

Restablece el PIN de un certificado y envía un correo electrónico al propietario para que elija uno nuevo.

NombreTipoRequeridoDescripción
certIdintegerSíID del certificado. Encuentra el valor en el campo certificateHandler devuelto por ListCertificates.
emailstringSíCorreo electrónico del propietario del certificado. La notificación de restablecimiento se envía a esta dirección.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:ResetPin>
            <urn:certId>14</urn:certId>
            <urn:email>ana.garcia@example.com</urn:email>
        </urn:ResetPin>
    </soap:Body>
</soap:Envelope>

Activa o desactiva certificados​

ChangeCertificatesStatus​

Cambia el estado activo o inactivo de uno o más certificados de forma simultánea.

NombreTipoRequeridoDescripción
certIdsarray de enterosSíIDs de los certificados que quieres actualizar. Encuentra los valores en el campo certificateHandler devuelto por ListCertificates. Puedes enviar varios IDs como se muestra en el ejemplo.
statusbooleanSíEstado que quieres aplicar: activo (true) o inactivo (false).
<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:ChangeCertificatesStatus>
            <urn:certIds>
                <!--Zero or more repetitions:-->
                <arr:int>243</arr:int>
                <arr:int>244</arr:int>
            </urn:certIds>
            <urn:status>true</urn:status>
        </urn:ChangeCertificatesStatus>
    </soap:Body>
</soap:Envelope>

Elimina certificados​

DeleteCertificate​

Elimina uno o más certificados del sistema de forma permanente.

NombreTipoRequeridoDescripción
certIdsarray de enterosSíIDs de los certificados que quieres eliminar. Encuentra los valores en el campo certificateHandler devuelto por ListCertificates. Puedes enviar varios IDs como se muestra en el ejemplo.
certTypeCertificateTypeSíTipo de los certificados que quieres eliminar. Todos los IDs en certIds deben pertenecer al mismo tipo. Valores: CA_ROOT, PRIVATE, PUBLIC_KEY_EMAIL, LOCAL_CA_ROOT, PRELOADED.
<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:DeleteCertificate>
            <urn:certIds>
                <!--Zero or more repetitions:-->
                <arr:int>14</arr:int>
                <arr:int>15</arr:int>
            </urn:certIds>
            <urn:certType>PRIVATE</urn:certType>
        </urn:DeleteCertificate>
    </soap:Body>
</soap:Envelope>

Recupera información de certificados​

ListCertificates​

Devuelve una lista paginada de certificados con sus datos principales.

NombreTipoRequeridoDescripción
viewTypeCertificatesViewTypeSíFiltra los certificados por estado. Valores: ViewAll, ViewExpired, ViewNotExpired, ViewWithOwner, ViewWithoutOwner, ViewActive, ViewInactive, ViewAssignable, ViewNoAssignable, ViewRenewal.
filterstringSíTexto que deben contener los resultados. Si está vacío, devuelve todos.
numBlockintegerSíNúmero de bloque de resultados que quieres obtener. Empieza en 0.
orderColumnOrderCertificatesColumnSíColumna por la que se ordenan los resultados: ORDER_BY_NAME, ORDER_BY_ACTIVE, ORDER_BY_EXPIRATION_DATE, ORDER_BY_TOTAL_USES, ORDER_BY_DATETIME_LAST_USAGE.
orderTypeOrderTypeSíDirección del orden: ORDER_ASCENDING o ORDER_DESCENDING.

Los resultados se devuelven en bloques de 1000 elementos. Usa numBlock (comenzando en 0) para paginar los resultados. Divide TotalItems de la respuesta entre 1000 y redondea al entero superior para obtener el número total de bloques.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:ListCertificates>
            <urn:viewType>ViewAll</urn:viewType>
            <urn:filter></urn:filter>
            <urn:numBlock>0</urn:numBlock>
            <urn:orderColumn>ORDER_BY_EXPIRATION_DATE</urn:orderColumn>
            <urn:orderType>ORDER_DESCENDING</urn:orderType>
        </urn:ListCertificates>
    </soap:Body>
</soap:Envelope>

GetCertificateData​

Devuelve los datos detallados de un certificado concreto.

NombreTipoRequeridoDescripción
certIdintegerSíID del certificado. Encuentra el valor en el campo certificateHandler devuelto por ListCertificates.
certTypeCertificateTypeSíTipo del certificado. Valores: CA_ROOT, PRIVATE, PUBLIC_KEY_EMAIL, LOCAL_CA_ROOT, PRELOADED.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:GetCertificateData>
            <urn:certId>14</urn:certId>
            <urn:certType>PRIVATE</urn:certType>
        </urn:GetCertificateData>
    </soap:Body>
</soap:Envelope>

ListCACertificates​

Devuelve la lista de certificados CA de un tipo determinado. Usa este método para obtener los IDs válidos para el parámetro issuerIds en AddCertificateUser.

NombreTipoRequeridoDescripción
certTypeCertificateTypeSíTipo de certificados CA que quieres listar. Valores válidos: CA_ROOT, LOCAL_CA_ROOT, PUBLIC_KEY_EMAIL.
filterstringNoTexto que deben contener los resultados. Si está vacío, devuelve todos.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:ListCACertificates>
            <urn:certType>LOCAL_CA_ROOT</urn:certType>
            <urn:filter></urn:filter>
        </urn:ListCACertificates>
    </soap:Body>
</soap:Envelope>

ListCertificateAttributes​

Devuelve la lista de tipos de atributos de certificado disponibles en el sistema. Usa este método para obtener los valores válidos de id para el parámetro certAttributes en AddCertificateUser.

NombreTipoRequeridoDescripción
filterstringNoTexto que deben contener los resultados. Si está vacío u omitido, devuelve todos los atributos.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:ListCertificateAttributes>
            <urn:filter></urn:filter>
        </urn:ListCertificateAttributes>
    </soap:Body>
</soap:Envelope>

Directivas de certificado​

AddCertificateDirective​

Crea una nueva directiva de certificado. Usa este método para añadir directivas que luego puedes asignar a usuarios de certificado mediante el parámetro certDirectiveIds en AddCertificateUser.

NombreTipoRequeridoDescripción
directivestringSíNombre de la directiva que quieres crear.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:AddCertificateDirective>
            <urn:directive>Directiva de ejemplo</urn:directive>
        </urn:AddCertificateDirective>
    </soap:Body>
</soap:Envelope>

ListCertificateDirectives​

Devuelve la lista de directivas de certificado configuradas en el sistema. Usa este método para obtener los IDs válidos para el parámetro certDirectiveIds en AddCertificateUser.

NombreTipoRequeridoDescripción
filterstringNoTexto que deben contener los resultados. Si está vacío u omitido, devuelve todas las directivas.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
    <soap:Header/>
    <soap:Body>
        <urn:ListCertificateDirectives>
            <urn:filter></urn:filter>
        </urn:ListCertificateDirectives>
    </soap:Body>
</soap:Envelope>