Obter logs de auditoria

Recupere logs de auditoria para uma organização do Automation Suite usando a API do portal, incluindo o escopo necessário, parâmetros de filtro e esquema de resposta.

Obtém os logs de auditoria de uma organização, com base no nome da organização.

Ponto de Extremidade da API

GET https://{yourDomain}/{organizationName}/portal_/api/auditLog/{partitionGlobalId}

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
language	String	Opcional. Especifica o idioma de exibição disponível, na forma reduzida. Por exemplo, en, fr, de, ja etc.
top	Int32	Opcional. Exibe as N principais entradas da auditoria.
skip	Int32	Opcional. Pula as N principais entradas da auditoria na exibição.
sortBy	String	Opcional. Especifica a propriedade DTO usada para classificar as entradas de auditoria. Por exemplo, createdOn, category, email, etc.
sortOrder	String	Opcional. Especifica a ordem de classificação. Por exemplo, crescente (asc) ou decrescente (desc).
api-version	String	Opcional. 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://{yourDomain}/{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://{yourDomain}/{organizationName}/portal_/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"
        }
    ]
}