Obter eventos de auditoria

Pontos de extremidade GET para recuperar eventos de auditoria da organização e do tenant, com caminhos separados para a experiência de registro em log clássica e a nova experiência de auditoria.

Recupere os logs de auditoria da sua organização. As APIs diferem dependendo da experiência de registro em log.

New Audit experience

A nova experiência de auditoria (logs unificados) usa esses pontos de extremidade de API e fornece dois escopos:

• Nível de organização: /orgaudit_/
• Nível do tenant: /tenantaudit_/

Essas APIs retornam informações de auditoria em todos os serviços da UiPath integrados à estrutura unificada.

Ponto de Extremidade da API

Para recuperar logs de auditoria na nova experiência de auditoria, você pode usar dois pontos de extremidade diferentes:

• Metadados: recupera todos os tipos de eventos de auditoria disponíveis, estruturados como uma hierarquia de fontes, categorias e atividades.

  Escopo	Ponto de Extremidade da API
  Nível da organização	GET {accessURL}/{org-name}/orgaudit_/api/query/sources

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/
Nível do tenant	GET {accessURL}/{org-name}/{tenant-name}/tenantaudit_/api/query/sources

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

• Eventos de consulta: recupera eventos de auditoria do escopo especificado, com filtragem avançada.

  Escopo	Ponto de Extremidade da API
  Nível da organização	GET {accessURL}/{org-name}/orgaudit_/api/query/events

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/
Nível do tenant	GET``https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events

Escopos

Requer um dos seguintes escopos:

• PM.Audit
• PM.Audit.Read

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Parâmetros de Consulta

Parâmetro	Tipo de dados	Description
from (opcional)	DateTime	Início do intervalo de tempo.
to (opcional)	DateTime	Fim do intervalo de tempo.
source (opcional)	Matriz [String]	Lista de origens de eventos (conforme retornado pela API de metadados ).
target (opcional)	Matriz [String]	Lista de categorias de eventos.
type (opcional)	Matriz [String]	Lista de tipos de atividade.
userIds (opcional)	Matriz [String]	Lista de identificadores de usuários.
searchTerm (opcional)	String	Palavra-chave ou termo a ser pesquisado.
status (opcional)	Número inteiro	0 = bem-sucedido 1 = falhou.
maxCount (opcional)	Número inteiro	Número máximo de gravações a serem retornadas.

Resposta

200 OK

Retorna um objeto JSON com:

• Lista de eventos de auditoria
• next link para paginação mostrando eventos mais recentes
• previous link para paginação mostrando eventos mais antigos

Resposta de exemplo

{
  "auditEvents": [
    {
      "id": "string",
      "createdOn": "2025-03-24T18:35:38.122Z",
      "organizationId": "string",
      "organizationName": "string",
      "tenantId": "string",
      "tenantName": "string",
      "actorId": "string",
      "actorName": "string",
      "actorEmail": "string",
      "eventType": "string",
      "eventSource": "string",
      "eventTarget": "string",
      "eventDetails": "string",
      "eventSummary": "string",
      "status": 0,
      "clientInfo": {
        "ipAddress": "string",
        "ipCountry": "string"
      }
    }
  ],
  "next": "string",
  "previous": "string"
}

Exemplos de solicitações

• Nível da organização

  curl --location 'https://cloud.uipath.com/{org-name}/orgaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z' \
  --header 'Authorization: Bearer {token}'
  

• Nível do tenant

  curl --location 'https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z' \
  --header 'Authorization: Bearer {token}'
  

Experiência de registro em log clássica

Recupera os registros de auditoria de uma organização com base em seu nome.

Ponto de Extremidade da API

GET {accessURL}/audit_/api/auditlogs/partitionGlobalId

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Escopos

Requer um dos seguintes escopos:

• PM.Audit
• PM.Audit.Read

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description
language (opcional)	String	Especifica o idioma de exibição disponível, na forma reduzida. Por exemplo, en, fr, de, ja etc.
top (opcional)	Int32	Exibe as N principais entradas da auditoria.
skip (opcional)	Int32	Pula as N principais entradas da auditoria na exibição.
sortBy (opcional)	String	Especifica a propriedade DTO usada para classificar as entradas de auditoria. Por exemplo, createdOn, category, email, etc.
sortOrder (opcional)	String	Especifica a ordem de classificação. Por exemplo, crescente (asc) ou decrescente (desc).
api-version (opcional)	String	Especifica a versão da API que você está usando.

Resposta

200 OK

Retorna os eventos de auditoria consultados.

Exemplo de solicitação

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

• Seu {baseURL} é: https://cloud.uipath.com/{organizationName}
• Seu {access_token} é: 1234 (para considerações de comprimento).
• Você define os seguintes parâmetros de consulta:
  • language = en
  • top = 2, para exibir as duas principais entradas
  • skip = 2, para pular as duas primeiras entradas
  • sortBy = createdOn, para classificar as entradas até o tempo de criação
  • sortOrder = asc, para classificar as entradas da entrada mais antiga para a mais recente

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request GET ' https://cloud.uipath.com/{organizationName}/audit_/api/auditlogs?language=en&top=2&skip=2&sortBy=createdOn&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Aqui está o corpo da resposta de uma recuperação bem-sucedida de entradas de auditoria:

{
    "totalCount": 29,
    "results": [
        {
            "createdOn": "2021-10-14T13:10:15.1964174+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        },
....
        {
            "createdOn": "2021-10-14T12:41:00.3268964+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        }
    ]
}