Obter eventos de auditoria

Retrieve the audit logs for your organization. The APIs differ depending on the logging experience.

Experiência de registro em log unificada

The unified logging experience uses these API endpoints and provides two scopes:

• Organization-level: /orgaudit_/
• Tenant-level: /tenantaudit_/

These APIs return audit information across UiPath services onboarded to the unified framework.

Ponto de Extremidade da API

For retrieving audit logs in the unified logging experience, you can use two different endpoints:

• Metadata: Retrieves all available audit event types, structured as a hierarchy of sources, categories, and activities.

  Escopo	Ponto de Extremidade da API
  Nível da organização	GET https://cloud.uipath.com/{org-name}/orgaudit_/api/query/sources
  Nível do tenant	GET https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/sources

• Query events: Retrieves audit events for the specified scope, with advanced filtering.

  Escopo	Ponto de Extremidade da API
  Nível da organização	GET https://cloud.uipath.com/{org-name}/orgaudit_/api/query/events
  Nível do tenant	GEThttps://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events

Escopos

Requires one of the following scopes:

• 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	Start of time interval.
to (opcional)	DateTime	End of time interval.
source (opcional)	Array [String]	List of event sources (as returned by the Metadata API).
target (opcional)	Array [String]	List of event categories.
type (opcional)	Array [String]	List of activity types.
userIds (opcional)	Array [String]	List of user identifiers.
searchTerm (opcional)	String	Keyword or term to search for.
status (opcional)	Número inteiro	0 = succeeded 1 = failed.
maxCount (opcional)	Número inteiro	Maximum number of records to return.

Resposta

200 OK

Returns a JSON object with:

• List of audit events

• next link for pagination showing newer events
• previous link for pagination showing older events

Example response

{
  "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"
}

Example requests

• Organization level

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

• Tenant level

  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

Retrieves audit logs for an organization based on its name.

Ponto de Extremidade da API

GET https://cloud.uipath.com/audit_/api/auditlogs/partitionGlobalId

Escopos

Requires one of the following scopes:

• 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"
        }
    ]
}