Saltar al contenido principal
Versión: 4.42

Referencia de la API — Gestión de políticas

Descripción general

Las políticas controlan qué certificados pueden usar qué usuarios, en qué aplicaciones y sitios, y cuándo. Esta documentación describe los métodos para gestionar el ciclo de vida completo de las políticas: crearlas, consultarlas, editarlas, activarlas o desactivarlas y eliminarlas.

nota

Antes de crear una política necesitas los IDs de los grupos de aplicaciones y grupos de sitios que quieres asociar. Consulta la referencia de gestión de grupos de políticas para crear esos recursos primero.

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.

Crea una política

AddPolicy

Crea una nueva política en el sistema.

NombreTipoRequeridoDescripción
namestringNombre de la política.
commentstringNoDescripción o comentario libre sobre la política.
priorityintegerPrioridad de la política. Los valores más bajos tienen mayor prioridad.
activebooleanSi es true, la política está activa desde el momento de su creación.
certificateIdsarray de enterosNoIDs de los certificados individuales incluidos en la política.
certificateGroupIdsarray de enterosNoIDs de los grupos de certificados incluidos en la política.
userUIdsarray de stringsNoUID de los usuarios incluidos en la política, en formato USER:<id>@<dominio>. Encuentra los valores en ListUsersInDomain.
applicationGroupIdsarray de enterosNoIDs de los grupos de aplicaciones donde se aplica la política. Encuentra los valores en ListApplicationGroups.
siteGroupIdsarray de enterosNoIDs de los grupos de sitios donde se aplica la política. Encuentra los valores en ListSiteGroups.
dssbooleanSi es true, la política permite el uso del servicio DSS.
macAgentbooleanSi es true, la política permite el uso del Agente macOS.
whensWhenPlanificación horaria de la política. Incluye: always (true para que la política sea siempre válida; false para usar franjas horarias personalizadas) y entries (lista de WhenEntry con days (días de la semana), startDate, endDate, startTime y endTime). Si always es true, envía entries vacío.
actionstringAcción de la política: ALLOW para permitir el uso del certificado, DENY para denegarlo.
allowAllBrowsersbooleanSi es true, la política aplica a todos los navegadores y allowedBrowsers se ignora.
allowedBrowsersarray de SupportedBrowsersNoNavegadores a los que aplica la política cuando allowAllBrowsers es false. Valores: IE, FF, CH, EDGE.
userPinPolicystringComportamiento del PIN de usuario: DO_NOTHING (no afecta al PIN), ASK_FOR_USER_PIN (solicita PIN al usuario), DONT_ASK_FOR_USER_PIN (no solicita PIN aunque el certificado lo requiera).
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soap:Header/>
<soap:Body>
<urn:AddPolicy>
<urn:name>Acceso portal corporativo</urn:name>
<urn:comment></urn:comment>
<urn:priority>1</urn:priority>
<urn:active>true</urn:active>
<urn:certificateIds/>
<urn:certificateGroupIds/>
<urn:userUIds/>
<urn:applicationGroupIds/>
<urn:siteGroupIds/>
<urn:dss>false</urn:dss>
<urn:macAgent>false</urn:macAgent>
<urn:whens>
<rtad:always>true</rtad:always>
<rtad:entries/>
</urn:whens>
<urn:action>ALLOW</urn:action>
<urn:allowAllBrowsers>true</urn:allowAllBrowsers>
<urn:allowedBrowsers>
<rtad:SupportedBrowsers></rtad:SupportedBrowsers>
</urn:allowedBrowsers>
<urn:userPinPolicy>DO_NOTHING</urn:userPinPolicy>
</urn:AddPolicy>
</soap:Body>
</soap:Envelope>

Consulta políticas

ListPolicies

Devuelve la lista de políticas del sistema con sus datos principales.

NombreTipoRequeridoDescripción
viewTypestringFiltra las políticas por tipo: VIEW_ALL, VIEW_ALLOWED (solo acción ALLOW), VIEW_DENIED (solo acción DENY), VIEW_ACTIVE, VIEW_INACTIVE.
filterstringNoTexto que deben contener los resultados. Si está vacío, devuelve todas las políticas.
numBlockintegerNúmero de bloque de resultados a devolver (paginación). El primer bloque es 0.
orderColumnstringColumna de ordenación: ORDER_BY_PRIORITY, ORDER_BY_STATUS, ORDER_BY_NAME, ORDER_BY_PERMISSION.
orderTypestringDirección de ordenación: ORDER_ASCENDING, ORDER_DESCENDING.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListPolicies>
<urn:viewType>VIEW_ALL</urn:viewType>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_PRIORITY</urn:orderColumn>
<urn:orderType>ORDER_ASCENDING</urn:orderType>
</urn:ListPolicies>
</soap:Body>
</soap:Envelope>

GetPolicyData

Devuelve los datos completos de una política, incluyendo los detalles de los certificados, usuarios, grupos de aplicaciones y grupos de sitios asociados.

NombreTipoRequeridoDescripción
policyIdintegerID de la política. Encuentra el valor en ListPolicies o ListPolicyIds.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:GetPolicyData>
<urn:policyId>10</urn:policyId>
</urn:GetPolicyData>
</soap:Body>
</soap:Envelope>

ListPolicyIds

Devuelve la lista de IDs de políticas. Usa este método para obtener los valores de policyId o policyIds.

NombreTipoRequeridoDescripción
viewTypestringFiltra las políticas por tipo: VIEW_ALL, VIEW_ALLOWED, VIEW_DENIED, VIEW_ACTIVE, VIEW_INACTIVE.
filterstringNoTexto que deben contener los resultados. Si está vacío, devuelve todos los IDs.
filterByActionstringNoFiltra por acción: ALLOW o DENY. No puede enviarse vacío.
filterByActivebooleanNoSi es true, devuelve solo políticas activas. Si es false, solo inactivas. No puede enviarse vacío.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListPolicyIds>
<urn:viewType>VIEW_ALL</urn:viewType>
<urn:filter></urn:filter>
<urn:filterByAction>ALLOW</urn:filterByAction>
<urn:filterByActive>true</urn:filterByActive>
</urn:ListPolicyIds>
</soap:Body>
</soap:Envelope>

Actualiza una política

EditPolicy

Actualiza una política existente. Todos los parámetros reemplazan los valores actuales por completo.

NombreTipoRequeridoDescripción
policyIdintegerID de la política que quieres actualizar. Encuentra el valor en ListPolicies.
namestringNombre de la política.
commentstringNoDescripción o comentario libre sobre la política.
priorityintegerPrioridad de la política. Los valores más bajos tienen mayor prioridad.
activebooleanEstado de la política.
certificateIdsarray de enterosNoIDs de los certificados individuales incluidos en la política.
certificateGroupIdsarray de enterosNoIDs de los grupos de certificados incluidos en la política.
userUIdsarray de stringsNoUID de los usuarios incluidos en la política.
applicationGroupIdsarray de enterosNoIDs de los grupos de aplicaciones donde se aplica la política.
siteGroupIdsarray de enterosNoIDs de los grupos de sitios donde se aplica la política.
dssbooleanSi es true, la política permite el uso del servicio DSS.
macAgentbooleanSi es true, la política permite el uso del Agente macOS.
whensWhenPlanificación horaria de la política. Misma estructura que en AddPolicy.
actionstringAcción de la política: ALLOW o DENY.
allowAllBrowsersbooleanSi es true, la política aplica a todos los navegadores.
allowedBrowsersarray de SupportedBrowsersNoNavegadores específicos cuando allowAllBrowsers es false. Valores: IE, FF, CH, EDGE.
userPinPolicystringComportamiento del PIN: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws" xmlns:rtad="http://schemas.datacontract.org/2004/07/RTAdminService.Types" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soap:Header/>
<soap:Body>
<urn:EditPolicy>
<urn:policyId>10</urn:policyId>
<urn:name>Acceso portal corporativo</urn:name>
<urn:comment>Permite el uso de certificados en el portal de la empresa</urn:comment>
<urn:priority>1</urn:priority>
<urn:active>true</urn:active>
<urn:certificateIds>
<arr:int>101</arr:int>
</urn:certificateIds>
<urn:certificateGroupIds/>
<urn:userUIds>
<arr:string>USER:1007@local.users</arr:string>
</urn:userUIds>
<urn:applicationGroupIds>
<arr:int>1</arr:int>
</urn:applicationGroupIds>
<urn:siteGroupIds>
<arr:int>2</arr:int>
</urn:siteGroupIds>
<urn:dss>false</urn:dss>
<urn:macAgent>false</urn:macAgent>
<urn:whens>
<rtad:always>false</rtad:always>
<rtad:entries>
<rtad:WhenEntry>
<rtad:days>
<rtad:DayOfWeek>Monday</rtad:DayOfWeek>
<rtad:DayOfWeek>Tuesday</rtad:DayOfWeek>
<rtad:DayOfWeek>Wednesday</rtad:DayOfWeek>
<rtad:DayOfWeek>Thursday</rtad:DayOfWeek>
<rtad:DayOfWeek>Friday</rtad:DayOfWeek>
</rtad:days>
<rtad:startTime>08:00:00</rtad:startTime>
<rtad:endTime>18:00:00</rtad:endTime>
</rtad:WhenEntry>
</rtad:entries>
</urn:whens>
<urn:action>ALLOW</urn:action>
<urn:allowAllBrowsers>false</urn:allowAllBrowsers>
<urn:allowedBrowsers>
<rtad:SupportedBrowsers>CH</rtad:SupportedBrowsers>
<rtad:SupportedBrowsers>EDGE</rtad:SupportedBrowsers>
<rtad:SupportedBrowsers>FF</rtad:SupportedBrowsers>
</urn:allowedBrowsers>
<urn:userPinPolicy>DO_NOTHING</urn:userPinPolicy>
</urn:EditPolicy>
</soap:Body>
</soap:Envelope>

Activa o desactiva políticas

ChangePoliciesStatus

Activa o desactiva una o más políticas a la vez.

NombreTipoRequeridoDescripción
policyIdsarray de enterosIDs de las políticas que quieres actualizar. Encuentra los valores en ListPolicyIds.
statusbooleanEstado que quieres aplicar: true para activar, false para desactivar.
<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:ChangePoliciesStatus>
<urn:policyIds>
<arr:int>10</arr:int>
<arr:int>11</arr:int>
</urn:policyIds>
<urn:status>false</urn:status>
</urn:ChangePoliciesStatus>
</soap:Body>
</soap:Envelope>

Asigna políticas a un rol

AssignRoleToPolicies

Reasigna un conjunto de políticas a un rol diferente.

NombreTipoRequeridoDescripción
roleIdintegerID del rol al que quieres asignar las políticas.
policyIdsarray de enterosIDs de las políticas que quieres reasignar. Encuentra los valores en ListPolicyIds.
<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:AssignRoleToPolicies>
<urn:roleId>3</urn:roleId>
<urn:policyIds>
<arr:int>10</arr:int>
<arr:int>11</arr:int>
</urn:policyIds>
</urn:AssignRoleToPolicies>
</soap:Body>
</soap:Envelope>

Elimina políticas

DeletePolicies

Elimina una o más políticas de forma permanente.

NombreTipoRequeridoDescripción
policyIdsarray de enterosIDs de las políticas que quieres eliminar. Encuentra los valores en ListPolicyIds.
<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:DeletePolicies>
<urn:policyIds>
<arr:int>10</arr:int>
</urn:policyIds>
</urn:DeletePolicies>
</soap:Body>
</soap:Envelope>

Exporta políticas

DownloadPoliciesCSV

Descarga un archivo CSV con la lista de políticas del sistema. Los parámetros van en la cabecera SOAP, no en el cuerpo.

NombreTipoRequeridoDescripción
basicFilter (cabecera)stringNoTexto que deben contener los resultados. Si está vacío, incluye todas las políticas.
viewType (cabecera)stringNoFiltra las políticas por tipo: VIEW_ALL, VIEW_ALLOWED, VIEW_DENIED, VIEW_ACTIVE, VIEW_INACTIVE.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header>
<urn:basicFilter></urn:basicFilter>
<urn:viewType>VIEW_ALL</urn:viewType>
</soap:Header>
<soap:Body>
<urn:DownloadPoliciesCSV/>
</soap:Body>
</soap:Envelope>

¿Te ha resultado útil esta página?