Version: 4.42

Referência de API — Gerenciamento de políticas

Visão geral

As políticas controlam quais certificados podem ser usados por quais usuários, em quais aplicações e sites, e quando. Esta documentação descreve os métodos para gerenciar o ciclo de vida completo das políticas: criar, consultar, editar, ativar ou desativar e excluí-las.

nota

Antes de criar uma política, você precisa dos IDs dos grupos de aplicações e grupos de sites que deseja associar a ela. Consulte a referência de gerenciamento de grupos de política para criar esses recursos primeiro.

Antes de começar

Antes de testar estes métodos, é necessário configurar o SoapUI.

important

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

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

Criar uma política

`AddPolicy`

Cria uma nova política no sistema.

Nome	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome da política.
`comment`	string	Não	Descrição ou comentário livre sobre a política.
`priority`	integer	Sim	Prioridade da política. Valores menores têm maior prioridade.
`active`	boolean	Sim	Se `true`, a política fica ativa a partir do momento em que é criada.
`certificateIds`	array de integers	Não	IDs dos certificados individuais incluídos na política.
`certificateGroupIds`	array de integers	Não	IDs dos grupos de certificados incluídos na política.
`userUIds`	array de strings	Não	UIDs dos usuários incluídos na política, no formato `USER:<id>@<domínio>`. Encontre os valores em `ListUsersInDomain`.
`applicationGroupIds`	array de integers	Não	IDs dos grupos de aplicações onde a política se aplica. Encontre os valores em `ListApplicationGroups`.
`siteGroupIds`	array de integers	Não	IDs dos grupos de sites onde a política se aplica. Encontre os valores em `ListSiteGroups`.
`dss`	boolean	Sim	Se `true`, a política permite o uso do serviço DSS.
`macAgent`	boolean	Sim	Se `true`, a política permite o uso do Agente macOS.
`whens`	When	Sim	Agenda de horários da política. Inclui: `always` (`true` para que a política seja sempre válida; `false` para usar intervalos de tempo personalizados) e `entries` (lista de `WhenEntry` com `days`, `startDate`, `endDate`, `startTime` e `endTime`). Se `always` for `true`, envie `entries` vazio.
`action`	string	Sim	Ação da política: `ALLOW` para permitir o uso do certificado, `DENY` para bloqueá-lo.
`allowAllBrowsers`	boolean	Sim	Se `true`, a política se aplica a todos os navegadores e `allowedBrowsers` é ignorado.
`allowedBrowsers`	array de SupportedBrowsers	Não	Navegadores aos quais a política se aplica quando `allowAllBrowsers` é `false`. Valores: `IE`, `FF`, `CH`, `EDGE`.
`userPinPolicy`	string	Sim	Comportamento do PIN do usuário: `DO_NOTHING` (sem efeito sobre o PIN), `ASK_FOR_USER_PIN` (solicita o PIN ao usuário), `DONT_ASK_FOR_USER_PIN` (não solicita o PIN mesmo que o certificado exija).

Requisição
Resposta

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

O campo ResultData contém o ID da nova política.

Consultar políticas

`ListPolicies`

Retorna a lista de políticas do sistema com seus dados principais.

Nome	Tipo	Obrigatório	Descrição
`viewType`	string	Sim	Filtra políticas por tipo: `VIEW_ALL`, `VIEW_ALLOWED` (somente ação ALLOW), `VIEW_DENIED` (somente ação DENY), `VIEW_ACTIVE`, `VIEW_INACTIVE`.
`filter`	string	Não	Texto que os resultados devem conter. Se vazio, retorna todas as políticas.
`numBlock`	integer	Sim	Número do bloco de resultados a retornar (paginação). O primeiro bloco é `0`.
`orderColumn`	string	Sim	Coluna de ordenação: `ORDER_BY_PRIORITY`, `ORDER_BY_STATUS`, `ORDER_BY_NAME`, `ORDER_BY_PERMISSION`.
`orderType`	string	Sim	Direção da ordenação: `ORDER_ASCENDING`, `ORDER_DESCENDING`.

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: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>Portal corporativo</c:string>
                            </b:sites>
                        </b:context>
                        <b:groups xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                            <c:string>Certificados corporativos</c:string>
                        </b:groups>
                        <b:idRole>-1</b:idRole>
                        <b:name>Acesso portal corporativo</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>

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

`GetPolicyData`

Retorna os dados completos de uma política, incluindo os detalhes dos certificados, usuários, grupos de aplicações e grupos de sites associados.

Nome	Tipo	Obrigatório	Descrição
`policyId`	integer	Sim	ID da política. Encontre o valor em `ListPolicies` ou `ListPolicyIds`.

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

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

`ListPolicyIds`

Retorna a lista de IDs de políticas. Use este método para obter valores de policyId ou policyIds.

Nome	Tipo	Obrigatório	Descrição
`viewType`	string	Sim	Filtra políticas por tipo: `VIEW_ALL`, `VIEW_ALLOWED`, `VIEW_DENIED`, `VIEW_ACTIVE`, `VIEW_INACTIVE`.
`filter`	string	Não	Texto que os resultados devem conter. Se vazio, retorna todos os IDs.
`filterByAction`	string	Não	Filtra por ação: `ALLOW` ou `DENY`. Não pode ser enviado vazio.
`filterByActive`	boolean	Não	Se `true`, retorna apenas políticas ativas. Se `false`, retorna apenas inativas. Não pode ser enviado vazio.

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

Atualizar uma política

`EditPolicy`

Atualiza uma política existente. Todos os parâmetros substituem completamente os valores atuais.

Nome	Tipo	Obrigatório	Descrição
`policyId`	integer	Sim	ID da política a atualizar. Encontre o valor em `ListPolicies`.
`name`	string	Sim	Nome da política.
`comment`	string	Não	Descrição ou comentário livre sobre a política.
`priority`	integer	Sim	Prioridade da política. Valores menores têm maior prioridade.
`active`	boolean	Sim	Status da política.
`certificateIds`	array de integers	Não	IDs dos certificados individuais incluídos na política.
`certificateGroupIds`	array de integers	Não	IDs dos grupos de certificados incluídos na política.
`userUIds`	array de strings	Não	UIDs dos usuários incluídos na política.
`applicationGroupIds`	array de integers	Não	IDs dos grupos de aplicações onde a política se aplica.
`siteGroupIds`	array de integers	Não	IDs dos grupos de sites onde a política se aplica.
`dss`	boolean	Sim	Se `true`, a política permite o uso do serviço DSS.
`macAgent`	boolean	Sim	Se `true`, a política permite o uso do Agente macOS.
`whens`	When	Sim	Agenda de horários da política. Mesma estrutura que em `AddPolicy`.
`action`	string	Sim	Ação da política: `ALLOW` ou `DENY`.
`allowAllBrowsers`	boolean	Sim	Se `true`, a política se aplica a todos os navegadores.
`allowedBrowsers`	array de SupportedBrowsers	Não	Navegadores específicos quando `allowAllBrowsers` é `false`. Valores: `IE`, `FF`, `CH`, `EDGE`.
`userPinPolicy`	string	Sim	Comportamento do PIN do usuário: `DO_NOTHING`, `ASK_FOR_USER_PIN`, `DONT_ASK_FOR_USER_PIN`.

Requisição
Resposta

<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>Acesso portal corporativo</urn:name>
            <urn:comment>Permite o uso de certificados no portal da 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>

O campo ResultData contém o ID da política atualizada.

Ativar ou desativar políticas

`ChangePoliciesStatus`

Ativa ou desativa uma ou mais políticas ao mesmo tempo.

Nome	Tipo	Obrigatório	Descrição
`policyIds`	array de integers	Sim	IDs das políticas a atualizar. Encontre os valores em `ListPolicyIds`.
`status`	boolean	Sim	Status a aplicar: `true` para ativar, `false` para desativar.

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

Atribuir políticas a um perfil

`AssignRoleToPolicies`

Reatribui um conjunto de políticas a um perfil diferente.

Nome	Tipo	Obrigatório	Descrição
`roleId`	integer	Sim	ID do perfil ao qual as políticas serão atribuídas.
`policyIds`	array de integers	Sim	IDs das políticas a reatribuir. Encontre os valores em `ListPolicyIds`.

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

Excluir políticas

`DeletePolicies`

Exclui permanentemente uma ou mais políticas.

Nome	Tipo	Obrigatório	Descrição
`policyIds`	array de integers	Sim	IDs das políticas a excluir. Encontre os valores em `ListPolicyIds`.

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

Exportar políticas

`DownloadPoliciesCSV`

Faz download de um arquivo CSV com a lista de políticas do sistema. Os parâmetros são enviados no cabeçalho SOAP, não no corpo.

Nome	Tipo	Obrigatório	Descrição
`basicFilter` (cabeçalho)	string	Não	Texto que os resultados devem conter. Se vazio, inclui todas as políticas.
`viewType` (cabeçalho)	string	Não	Filtra políticas por tipo: `VIEW_ALL`, `VIEW_ALLOWED`, `VIEW_DENIED`, `VIEW_ACTIVE`, `VIEW_INACTIVE`.

Requisição
Resposta

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

O status do resultado e o nome do arquivo são retornados no cabeçalho SOAP da resposta. O conteúdo do arquivo é enviado no corpo como um anexo binário MTOM.

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

Esta página foi útil?

Visão geral​

Antes de começar​

Criar uma política​

AddPolicy​

Consultar políticas​

ListPolicies​

GetPolicyData​

ListPolicyIds​

Atualizar uma política​

EditPolicy​

Ativar ou desativar políticas​

ChangePoliciesStatus​

Atribuir políticas a um perfil​

AssignRoleToPolicies​

Excluir políticas​

DeletePolicies​

Exportar políticas​

DownloadPoliciesCSV​