test-cloud

latest

false

Importante :

La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía de la API de Test Cloud

Obtener eventos de auditoría

Recupera los registros de auditoría de tu organización. Las API difieren en función de la experiencia de registro.

New Audit experience

The new Audit experience (Unified logs) uses these API endpoints and provides two scopes:

Nivel de organización: /orgaudit_/
Nivel de tenant: /tenantaudit_/

Estas API devuelven información de auditoría en los servicios de UiPath incorporados al marco unificado.

Punto final de API

For retrieving audit logs in the new Audit experience, you can use two different endpoints:

Metadatos: recupera todos los tipos de eventos de auditoría disponibles, estructurados como una jerarquía de orígenes, categorías y actividades.

Ámbito Punto final de API
Nivel de organización GET {accessURL}/{org-name}/orgaudit_/api/query/sources

Ámbito	Punto final de API
Nivel de organización	`GET` `{accessURL}/{org-name}/orgaudit_/api/query/sources`

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`
Nivel tenant	`GET` `{accessURL}/{org-name}/{tenant-name}/tenantaudit_/api/query/sources`

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Eventos de consulta: recupera eventos de auditoría para el ámbito especificado, con filtrado avanzado.

Ámbito Punto final de API
Nivel de organización GET {accessURL}/{org-name}/orgaudit_/api/query/events

Ámbito	Punto final de API
Nivel de organización	`GET` `{accessURL}/{org-name}/orgaudit_/api/query/events`

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`
Nivel tenant	GET``https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.Audit
PM.Audit.Read

Solicitar encabezados.

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

Parámetros de consulta

Parámetro	Tipo de datos	Descripción
`from` (opcional)	Datetime	Inicio del intervalo de tiempo.
`to` (opcional)	Datetime	Fin del intervalo de tiempo.
`source` (opcional)	Matriz [String]	Lista de orígenes de eventos (tal como los devuelve la API de metadatos ).
`target` (opcional)	Matriz [String]	Lista de categorías de eventos.
`type` (opcional)	Matriz [String]	Lista de tipos de actividad.
`userIds` (opcional)	Matriz [String]	Lista de identificadores de usuario.
`searchTerm` (opcional)	Cadena	Palabra clave o término a buscar.
`status` (opcional)	Entero	0 = correcto 1 = fallido.
`maxCount` (opcional)	Entero	Número máximo de registros que se devolverán.

Respuesta

200 OK

Devuelve un objeto JSON con:

Lista de eventos de auditoría
Enlace next para la paginación que muestra los eventos más recientes
Enlace previous para la paginación que muestra eventos más antiguos

Respuesta de ejemplo

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

Solicitudes de ejemplo

Nivel de organización

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

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

Experiencia de registros clásicos

Recupera los registros de auditoría de una organización en función de su nombre.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	`https://cloud.uipath.com/`
Test Cloud Sector Público	`https://govcloud.uipath.us/`
Test Cloud Dedicado	`https://{customURL}.dedicated.uipath.com/`

Ámbitos

Requiere uno de los siguientes ámbitos:

PM.Audit
PM.Audit.Read

Solicitar encabezados.

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

Parámetros de consulta

Parámetros de consulta	Tipo de datos	Descripción
`language` (opcional)	String	Specify the available display language, in the shorten form. For example, `en`, `fr`, `de`, or `ja`.
`top` (opcional)	Int32	Muestra las primeras N entradas de la auditoría.
`skip` (opcional)	Int32	Omite las primeras N muestras de una auditoría.
`sortBy` (opcional)	String	Specify the DTO property used to sort audit entries by. For example, `createdOn`, `category`, or `email`.
`sortOrder` (opcional)	String	Especifica el orden de clasificación. Por ejemplo, ascendente (`asc`) o descendente (`desc`).
`api-version` (opcional)	String	Especifica la versión API que utilizas.

Respuesta

200 OK

Devuelve los eventos de auditoría consultados.

Solicitud de ejemplo

Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.

Tu {baseURL} es: https://cloud.uipath.com/{organizationName}
Tu {access_token} es: 1234 (para consideraciones de longitud)
Puedes establecer los siguientes parámetros de consulta:
- language = en
- top = 2, para mostrar las dos primeras entradas
- skip = 2, para omitir las dos primeras entradas
- sortBy = createdOn, para ordenar las entradas por hora de su creación
- sortOrder = asc, para ordenar las entradas de más antigua a más reciente

La llamada debe parecerse al siguiente ejemplo (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'
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'

El cuerpo de respuesta de una entrada de auditoría exitosa es así:

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

¿Te ha resultado útil esta página?

AnteriorRegistros de auditoría

Sig.Descargar eventos

Guía de la API de Test Cloud

New Audit experience​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Parámetros de consulta​

Respuesta​

200 OK​

Respuesta de ejemplo​

Solicitudes de ejemplo​

Experiencia de registros clásicos​

Punto final de API​

Ámbitos​

Solicitar encabezados.​

Parámetros de consulta​

Respuesta​

200 OK​

Solicitud de ejemplo​

¿Te ha resultado útil esta página?

New Audit experience

Punto final de API

Ámbitos

Solicitar encabezados.

Parámetros de consulta

Respuesta

200 OK

Respuesta de ejemplo

Solicitudes de ejemplo

Experiencia de registros clásicos

Punto final de API

Ámbitos

Solicitar encabezados.

Parámetros de consulta

Respuesta

200 OK

Solicitud de ejemplo