Referência da API — Consulta de eventos
Visão geral
A API de Administração disponibiliza três tipos de eventos que você pode consultar e exportar:
- Eventos de certificado: registram cada uso de certificado (assinatura, autenticação, operações negadas por política).
- Eventos do sistema: registram ações realizadas no console de administração (alterações de configuração, gestão de usuários, criação de políticas).
- Eventos de HA: registram a atividade do cluster de alta disponibilidade.
Antes de começar
Antes de testar estes métodos, você precisa configurar o SoapUI.
Os comentários <!--Optional:--> que aparecem nas requisições SOAP são gerados automaticamente e podem marcar incorretamente campos obrigatórios como opcionais.
Esta documentação indica explicitamente quais campos são obrigatórios ou opcionais. Sempre siga esta documentação.
Eventos de certificado
ListEvents
Retorna a lista de eventos de uso de certificados que correspondem aos parâmetros especificados, ordenados por data.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
filter | string | Não | Texto que os resultados devem conter. Se vazio, retorna todos os eventos. |
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_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_CONTEXT, ORDER_BY_CERTIFICATE, ORDER_BY_DESCRIPTION, ORDER_BY_URL. |
orderType | string | Sim | Direção da ordenação: ORDER_ASCENDING, ORDER_DESCENDING. |
filterType | string | Sim | Filtra por tipo de evento: NO_FILTER, FILTER_BY_SECURITY (sessão), FILTER_BY_CERTIFICATE_OPERATION (uso de certificado), FILTER_BY_PERMISSION_DENIED, FILTER_BY_PERMISSION_ALLOWED, FILTER_BY_CERT_LIFECYCLE. |
dateFilterType | string | Sim | Filtro de data predefinido: NO_DATE_FILTER, DATE_FILTER_TODAY, DATE_FILTER_THIS_WEEK, DATE_FILTER_THIS_MONTH, DATE_FILTER_LAST_THREE_MONTHS, DATE_FILTER_LAST_SIX_MONTHS, DATE_FILTER_THIS_YEAR, DATE_FILTER_CUSTOM_FILTER. Use DATE_FILTER_CUSTOM_FILTER para especificar um intervalo com from e to. |
from | datetime | Não | Data de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
to | datetime | Não | Data de fim do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
- 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:ListEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:filterType>NO_FILTER</urn:filterType>
<urn:dateFilterType>DATE_FILTER_TODAY</urn:dateFilterType>
</urn:ListEvents>
</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/ListEventsResponse</a:Action>
</s:Header>
<s:Body>
<ListEventsResponse 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:ArrayOfEventView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
<b:EventView>
<b:certificate/>
<b:context xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<c:string>Process: chrome</c:string>
<c:string>Original process: chrome.exe</c:string>
<c:string>Agent id: XXXX-XXXXX-XXXXX-XXXXX</c:string>
</b:context>
<b:date>2026-04-22T09:30:00</b:date>
<b:description>Application connection accepted</b:description>
<b:ip>192.168.1.100</b:ip>
<b:url>{"process":"chrome","browserType":"CH","fullUrl":"https://example.com","policyName":"Corporate portal access","agentId":"XXXX-XXXXX-XXXXX-XXXXX"}</b:url>
<b:user>juan.garcia@local.users</b:user>
</b:EventView>
</ResultData>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
</Result>
</ListEventsResponse>
</s:Body>
</s:Envelope>
Consulte a referência completa dos campos de EventView em Objetos de resposta.
Eventos do sistema
ListSystemEvents
Retorna a lista de eventos de atividade do console de administração que correspondem aos parâmetros especificados, ordenados por data.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
filter | string | Não | Texto que os resultados devem conter. Se vazio, retorna todos os eventos. |
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_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION. |
orderType | string | Sim | Direção da ordenação: ORDER_ASCENDING, ORDER_DESCENDING. |
dateFilterType | string | Sim | Filtro de data predefinido. Mesmos valores de ListEvents. |
from | datetime | Não | Data de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
to | datetime | Não | Data de fim do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
- 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:ListSystemEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:dateFilterType>DATE_FILTER_THIS_WEEK</urn:dateFilterType>
</urn:ListSystemEvents>
</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/ListSystemEventsResponse</a:Action>
</s:Header>
<s:Body>
<ListSystemEventsResponse 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:ArrayOfSystemEventView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
<b:SystemEventView>
<b:context xmlns:c="http://schemas.datacontract.org/2004/07/System">
<c:ValueTupleOfstringstring>
<c:Item1>Friendly Name</c:Item1>
<c:Item2>maria</c:Item2>
</c:ValueTupleOfstringstring>
<c:ValueTupleOfstringstring>
<c:Item1>Email</c:Item1>
<c:Item2>maria@test.com</c:Item2>
</c:ValueTupleOfstringstring>
<c:ValueTupleOfstringstring>
<c:Item1>Domain</c:Item1>
<c:Item2>local.users</c:Item2>
</c:ValueTupleOfstringstring>
</b:context>
<b:dateTime>2026-03-23T11:12:57</b:dateTime>
<b:information>El usuario maria.lopez@local.users ha sido creado.</b:information>
<b:ip>172.22.0.7</b:ip>
<b:newData>{"username":"maria.lopez","email":"maria@test.com","active":true,"name":"maria","domain":"local.users"}</b:newData>
<b:oldData i:nil="true"/>
<b:section>Admin WS: AddLocalUser</b:section>
<b:user>admin@local</b:user>
</b:SystemEventView>
</ResultData>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
</Result>
</ListSystemEventsResponse>
</s:Body>
</s:Envelope>
Consulte a referência completa dos campos de SystemEventView em Objetos de resposta.
Eventos de HA
ListHAEvents
Retorna a lista de eventos do cluster de alta disponibilidade que correspondem aos parâmetros especificados, ordenados por data. Retorna objetos SystemEventView no mesmo formato que ListSystemEvents.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
filter | string | Não | Texto que os resultados devem conter. Se vazio, retorna todos os eventos. |
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_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION. |
orderType | string | Sim | Direção da ordenação: ORDER_ASCENDING, ORDER_DESCENDING. |
dateFilterType | string | Sim | Filtro de data predefinido. Mesmos valores de ListEvents. |
from | datetime | Não | Data de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
to | datetime | Não | Data de fim do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
- 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:ListHAEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:dateFilterType>NO_DATE_FILTER</urn:dateFilterType>
</urn:ListHAEvents>
</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/ListHAEventsResponse</a:Action>
</s:Header>
<s:Body>
<ListHAEventsResponse 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:ArrayOfSystemEventView" xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">
<b:SystemEventView>
<b:context i:nil="true"/>
<b:dateTime>2026-04-20T03:00:00</b:dateTime>
<b:information>Node failover completed</b:information>
<b:ip>192.168.1.51</b:ip>
<b:newData i:nil="true"/>
<b:oldData i:nil="true"/>
<b:section>HA</b:section>
<b:user i:nil="true"/>
</b:SystemEventView>
</ResultData>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/RTService.ModelsResult">1</TotalItems>
</Result>
</ListHAEventsResponse>
</s:Body>
</s:Envelope>
Consulte a referência completa dos campos de SystemEventView em Objetos de resposta.
Exportar eventos
DownloadCSVEvents
Faz o download de um arquivo CSV com os eventos de certificado que correspondem aos parâmetros especificados. 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 todos os eventos. |
filterType (cabeçalho) | string | Sim | Filtra por tipo de evento. Mesmos valores de ListEvents. |
dateFilterType (cabeçalho) | string | Sim | Filtro de data predefinido. Mesmos valores de ListEvents. |
from (cabeçalho) | datetime | Não | Data de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
to (cabeçalho) | datetime | Não | Data de fim do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER. |
- 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:filterType>NO_FILTER</urn:filterType>
<urn:dateFilterType>NO_DATE_FILTER</urn:dateFilterType>
</soap:Header>
<soap:Body>
<urn:CSVFilteredWithDatesMessage/>
</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 está 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/DownloadCSVEventsResponse</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">Events_202605061401.csv</Filename>
</h:result>
</s:Header>
<s:Body>
<ResultFileStream xmlns="urn:evolium:redtrust:administration:ws">
<stream>
<xop:Include href="cid:http://tempuri.org/1/639136728960186888" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</stream>
</ResultFileStream>
</s:Body>
</s:Envelope>
Esta página foi útil?