Obtener registros de auditoría

Obtiene los registros de auditoría de una organización según el nombre de la organización.

Punto final de API

GET https://{yourDomain}/audit_/api/auditlogs

Ámbitos

Necesita los siguientes ámbitos:

• PM.Audit
• PM.Audit.Read

Solicitar encabezados.

--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	Especifica el idioma de visualización disponible en forma acortada. Por ejemplo, en, fr, de, ja etc.
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	Especifica la propiedad DTO utilizada para ordenar las entradas de auditoría. Por ejemplo, createdOn, category, email, etc.
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://{yourDomain}/{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 ser similar a lo que mostramos a continuación (cURL):

curl --location --request GET ' https://{yourDomain}/{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"
        }
    ]
}