API reference — Policy management
Overview
Policies control which certificates can be used by which users, in which applications and sites, and when. This documentation describes the methods for managing the full policy lifecycle: creating, querying, editing, enabling or disabling, and deleting them.
Before creating a policy you need the IDs of the application groups and site groups you want to associate with it. See the policy group management reference to create those resources first.
Before you start
Before testing these methods, you need to set up SoapUI.
The <!--Optional:--> comments that appear in SOAP requests are generated automatically and may incorrectly mark required fields as optional.
This documentation explicitly states which fields are required or optional. Always trust this documentation.
Create a policy
AddPolicy
Creates a new policy in the system.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Policy name. |
comment | string | No | Free-form description or comment about the policy. |
priority | integer | Yes | Policy priority. Lower values have higher priority. |
active | boolean | Yes | If true, the policy is active from the moment it is created. |
certificateIds | array of integers | No | IDs of the individual certificates included in the policy. |
certificateGroupIds | array of integers | No | IDs of the certificate groups included in the policy. |
userUIds | array of strings | No | UIDs of the users included in the policy, in the format USER:<id>@<domain>. Find the values in ListUsersInDomain. |
applicationGroupIds | array of integers | No | IDs of the application groups where the policy applies. Find the values in ListApplicationGroups. |
siteGroupIds | array of integers | No | IDs of the site groups where the policy applies. Find the values in ListSiteGroups. |
dss | boolean | Yes | If true, the policy allows use of the DSS service. |
macAgent | boolean | Yes | If true, the policy allows use of the macOS Agent. |
whens | When | Yes | Policy time schedule. Includes: always (true for the policy to be always valid; false to use custom time slots) and entries (list of WhenEntry with days, startDate, endDate, startTime, and endTime). If always is true, send entries empty. |
action | string | Yes | Policy action: ALLOW to permit certificate use, DENY to block it. |
allowAllBrowsers | boolean | Yes | If true, the policy applies to all browsers and allowedBrowsers is ignored. |
allowedBrowsers | array of SupportedBrowsers | No | Browsers the policy applies to when allowAllBrowsers is false. Values: IE, FF, CH, EDGE. |
userPinPolicy | string | Yes | User PIN behavior: DO_NOTHING (no effect on PIN), ASK_FOR_USER_PIN (prompts the user for PIN), DONT_ASK_FOR_USER_PIN (does not prompt for PIN even if the certificate requires it). |
- Request
- Response
<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>
<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/AddPolicyResponse</a:Action>
</s:Header>
<s:Body>
<AddPolicyResponse 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">10</ResultData>
</Result>
</AddPolicyResponse>
</s:Body>
</s:Envelope>
The ResultData field contains the ID of the new policy.
Query policies
ListPolicies
Returns the list of policies in the system with their main data.
| Name | Type | Required | Description |
|---|---|---|---|
viewType | string | Yes | Filters policies by type: VIEW_ALL, VIEW_ALLOWED (ALLOW action only), VIEW_DENIED (DENY action only), VIEW_ACTIVE, VIEW_INACTIVE. |
filter | string | No | Text that results must contain. If empty, returns all policies. |
numBlock | integer | Yes | Result block number to return (pagination). The first block is 0. |
orderColumn | string | Yes | Sort column: ORDER_BY_PRIORITY, ORDER_BY_STATUS, ORDER_BY_NAME, ORDER_BY_PERMISSION. |
orderType | string | Yes | Sort direction: ORDER_ASCENDING, ORDER_DESCENDING. |
- Request
- Response
<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>
<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/ListPoliciesResponse</a:Action>
</s:Header>
<s:Body>
<ListPoliciesResponse 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="b:ArrayOfPolicyView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
<b:PolicyView>
<b:action>ALLOW</b:action>
<b:active>false</b:active>
<b:certificates xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<b:context>
<b:apps xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<b:browsers xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<c:string>All browsers</c:string>
</b:browsers>
<b:dss>false</b:dss>
<b:macAgent>false</b:macAgent>
<b:sites xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<c:string>Corporate portal</c:string>
</b:sites>
</b:context>
<b:groups xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<c:string>Corporate certificates</c:string>
</b:groups>
<b:idRole>-1</b:idRole>
<b:name>Corporate portal access</b:name>
<b:policyId>10</b:policyId>
<b:priority>1</b:priority>
<b:role/>
<b:userGroups xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<c:string>UserGroup_local.users@local.users</c:string>
</b:userGroups>
<b:userPinPolicy>DO_NOTHING</b:userPinPolicy>
<b:users xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
</b:PolicyView>
</ResultData>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
</Result>
</ListPoliciesResponse>
</s:Body>
</s:Envelope>
See the full field reference for PolicyView in Response objects.
GetPolicyData
Returns the full data for a policy, including the details of its associated certificates, users, application groups, and site groups.
| Name | Type | Required | Description |
|---|---|---|---|
policyId | integer | Yes | Policy ID. Find the value in ListPolicies or ListPolicyIds. |
- Request
- Response
<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>
<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/GetPolicyDataResponse</a:Action>
</s:Header>
<s:Body>
<GetPolicyDataResponse 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="b:Policy" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
<b:action>ALLOW</b:action>
<b:active>false</b:active>
<b:allowAllBrowser>true</b:allowAllBrowser>
<b:allowedBrowsers i:nil="true"/>
<b:applications/>
<b:certificateGroups/>
<b:certificates>
<b:Certificate>
<b:active>true</b:active>
<b:alias>another-certificate</b:alias>
<b:certificateHandler>1021</b:certificateHandler>
<b:certificateUserPinPolicy>NO_USER_PIN</b:certificateUserPinPolicy>
<b:expirationDate>2028-10-30T10:06:59</b:expirationDate>
<b:groupHandlers i:nil="true" xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<b:needPin>false</b:needPin>
<b:policyHandlers i:nil="true" xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<b:usageReason>false</b:usageReason>
<b:userHandlers i:nil="true" xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
</b:Certificate>
</b:certificates>
<b:comment/>
<b:dss>false</b:dss>
<b:macAgent>false</b:macAgent>
<b:name>Izenpe - Egoitza Gipuzkoa</b:name>
<b:policyId>14</b:policyId>
<b:priority>1</b:priority>
<b:sites/>
<b:userPinPolicy>DO_NOTHING</b:userPinPolicy>
<b:users>
<b:UserView>
<b:consumeLicense>true</b:consumeLicense>
<b:domain>elena.local</b:domain>
<b:email>final@mail.com</b:email>
<b:friendlyName>final</b:friendlyName>
<b:groupType>USER</b:groupType>
<b:lastCertificateUsage>2026-04-28T12:25:18.483</b:lastCertificateUsage>
<b:passwordExpirationDate i:nil="true"/>
<b:status>true</b:status>
<b:type>LOCAL_USER</b:type>
<b:uid>USER:4@elena.local</b:uid>
<b:userHandler>4</b:userHandler>
<b:username>final</b:username>
</b:UserView>
</b:users>
<b:when>
<b:always>true</b:always>
<b:entries/>
</b:when>
</ResultData>
</Result>
</GetPolicyDataResponse>
</s:Body>
</s:Envelope>
See the full field reference for Policy in Response objects.
ListPolicyIds
Returns the list of policy IDs. Use this method to get policyId or policyIds values.
| Name | Type | Required | Description |
|---|---|---|---|
viewType | string | Yes | Filters policies by type: VIEW_ALL, VIEW_ALLOWED, VIEW_DENIED, VIEW_ACTIVE, VIEW_INACTIVE. |
filter | string | No | Text that results must contain. If empty, returns all IDs. |
filterByAction | string | No | Filters by action: ALLOW or DENY. Cannot be sent empty. |
filterByActive | boolean | No | If true, returns only active policies. If false, returns only inactive. Cannot be sent empty. |
- Request
- Response
<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>
<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/ListPolicyIdsResponse</a:Action>
</s:Header>
<s:Body>
<ListPolicyIdsResponse 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:ArrayOfint" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult" xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<c:int>10</c:int>
<c:int>11</c:int>
<c:int>12</c:int>
</ResultData>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">3</TotalItems>
</Result>
</ListPolicyIdsResponse>
</s:Body>
</s:Envelope>
Update a policy
EditPolicy
Updates an existing policy. All parameters fully replace the current values.
| Name | Type | Required | Description |
|---|---|---|---|
policyId | integer | Yes | ID of the policy to update. Find the value in ListPolicies. |
name | string | Yes | Policy name. |
comment | string | No | Free-form description or comment about the policy. |
priority | integer | Yes | Policy priority. Lower values have higher priority. |
active | boolean | Yes | Policy status. |
certificateIds | array of integers | No | IDs of the individual certificates included in the policy. |
certificateGroupIds | array of integers | No | IDs of the certificate groups included in the policy. |
userUIds | array of strings | No | UIDs of the users included in the policy. |
applicationGroupIds | array of integers | No | IDs of the application groups where the policy applies. |
siteGroupIds | array of integers | No | IDs of the site groups where the policy applies. |
dss | boolean | Yes | If true, the policy allows use of the DSS service. |
macAgent | boolean | Yes | If true, the policy allows use of the macOS Agent. |
whens | When | Yes | Policy time schedule. Same structure as in AddPolicy. |
action | string | Yes | Policy action: ALLOW or DENY. |
allowAllBrowsers | boolean | Yes | If true, the policy applies to all browsers. |
allowedBrowsers | array of SupportedBrowsers | No | Specific browsers when allowAllBrowsers is false. Values: IE, FF, CH, EDGE. |
userPinPolicy | string | Yes | User PIN behavior: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN. |
- Request
- Response
<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>
<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/EditPolicyResponse</a:Action>
</s:Header>
<s:Body>
<EditPolicyResponse 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">10</ResultData>
</Result>
</EditPolicyResponse>
</s:Body>
</s:Envelope>
The ResultData field contains the ID of the updated policy.
Enable or disable policies
ChangePoliciesStatus
Enables or disables one or more policies at once.
| Name | Type | Required | Description |
|---|---|---|---|
policyIds | array of integers | Yes | IDs of the policies to update. Find the values in ListPolicyIds. |
status | boolean | Yes | Status to apply: true to enable, false to disable. |
- Request
- Response
<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>
<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/ChangePoliciesStatusResponse</a:Action>
</s:Header>
<s:Body>
<ChangePoliciesStatusResponse 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>
</ChangePoliciesStatusResponse>
</s:Body>
</s:Envelope>
Assign policies to a role
AssignRoleToPolicies
Reassigns a set of policies to a different role.
| Name | Type | Required | Description |
|---|---|---|---|
roleId | integer | Yes | ID of the role to assign the policies to. |
policyIds | array of integers | Yes | IDs of the policies to reassign. Find the values in ListPolicyIds. |
- Request
- Response
<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>
<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/AssignRoleToPoliciesResponse</a:Action>
</s:Header>
<s:Body>
<AssignRoleToPoliciesResponse 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>
</AssignRoleToPoliciesResponse>
</s:Body>
</s:Envelope>
Delete policies
DeletePolicies
Permanently deletes one or more policies.
| Name | Type | Required | Description |
|---|---|---|---|
policyIds | array of integers | Yes | IDs of the policies to delete. Find the values in ListPolicyIds. |
- Request
- Response
<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>
<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/DeletePoliciesResponse</a:Action>
</s:Header>
<s:Body>
<DeletePoliciesResponse 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>
</DeletePoliciesResponse>
</s:Body>
</s:Envelope>
Export policies
DownloadPoliciesCSV
Downloads a CSV file with the list of policies in the system. Parameters go in the SOAP header, not the body.
| Name | Type | Required | Description |
|---|---|---|---|
basicFilter (header) | string | No | Text that results must contain. If empty, includes all policies. |
viewType (header) | string | No | Filters policies by type: VIEW_ALL, VIEW_ALLOWED, VIEW_DENIED, VIEW_ACTIVE, VIEW_INACTIVE. |
- Request
- Response
<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>
The result status and filename are returned in the SOAP response header. The file content is in the body as an MTOM binary attachment.
<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/DownloadPoliciesCSVResponse</a:Action>
<h:result s:mustUnderstand="1" xmlns:h="urn:evolium:redtrust:administration:ws" 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>
<Filename xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">Policies_202605071142.csv</Filename>
</h:result>
</s:Header>
<s:Body>
<ResultFileStream xmlns="urn:evolium:redtrust:administration:ws">
<stream>
<xop:Include href="cid:http://tempuri.org/1/639137509688734956" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</stream>
</ResultFileStream>
</s:Body>
</s:Envelope>
Was this page helpful?