Audit Log - Query

Referência

Service:: Audit

API Version:: 7.1-preview.1

Consultas de entradas de log de auditoria

GET https://auditservice.dev.azure.com/{organization}/_apis/audit/auditlog?api-version=7.1-preview.1

With optional parameters:

GET https://auditservice.dev.azure.com/{organization}/_apis/audit/auditlog?startTime={startTime}&endTime={endTime}&batchSize={batchSize}&continuationToken={continuationToken}&skipAggregation={skipAggregation}&api-version=7.1-preview.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path		string	O nome da organização do Azure DevOps.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.
batchSize	query		integer int32	Número máximo de resultados a serem retornados. Opcional
continuationToken	query		string	Token usado para retornar o próximo conjunto de resultados da consulta anterior. Opcional
endTime	query		string date-time	Hora de término da janela de download. Opcional
skipAggregation	query		boolean	Ignora a agregação de eventos e os deixa como entradas individuais. Por padrão, os eventos são agregados. Tipos de evento agregados: AuditLog.AccessLog.
startTime	query		string date-time	Hora de início da janela de download. Opcional

Respostas

Nome	Tipo	Description
200 OK	AuditLogQueryResult	operação bem-sucedida

Segurança

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nome	Description
vso.auditlog	Concede a capacidade de ler o log de auditoria e os fluxos de auditoria para os usuários

Exemplos

By date

Sample Request

HTTP

GET https://auditservice.dev.azure.com/_apis/audit/auditlog?startTime=2019-03-04T14:05:59.928Z&endTime=2019-03-05T14:05:59.928Z&batchSize=2&api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "value": {
    "decoratedAuditLogEntries": [
      {
        "id": "2518505060978539161;00000064-0000-8888-8000-000000000000;86fbe369-3f5d-4f52-9ab0-3be7db271948",
        "correlationId": "86fbe369-3f5d-4f52-9ab0-3be7db271948",
        "activityId": "033fde68-f713-4984-b24f-8d7a73d1ade6",
        "actorCUID": "a718550e-4777-4058-8298-bff88d0cb524",
        "actorUserId": "d6a98b6c-6932-485c-a986-aea9fc981df0",
        "authenticationMechanism": "FedAuth",
        "timestamp": "2019-03-05T14:05:02.1460838+00:00",
        "scopeType": "organization",
        "scopeDisplayName": "fabrikam (Organization)",
        "scopeId": "73638cd5-0dda-4128-9fd6-48c16d4e4de3",
        "ipAddress": "167.220.148.131",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.119 Safari/537.36",
        "actionId": "AuditLog.AccessLog",
        "data": {
          "Filter": {
            "StartTime": "2019-03-04T14:05:59.928Z",
            "EndTime": "2019-03-05T14:05:59.928Z",
            "ContinuationToken": null,
            "BatchSize": 2,
            "HasMore": true
          },
          "EventSummary": [
            "2019-03-05T14:05:02.1460838+00:00",
            "2019-03-05T13:59:40.4899467+00:00",
            "2019-03-05T13:58:13.159128+00:00"
          ]
        },
        "details": "Accessed the audit log 3 times",
        "area": "Auditing",
        "category": "access",
        "categoryDisplayName": "Access",
        "actorDisplayName": "Norman Paulk",
        "actorImageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.NzdhMTNiN2MtYjIxNy03NDc4LWIxMjItYTlhMTU5YTFlNWQw"
      },
      {
        "id": "2518505063644965580;00000002-0000-8888-8000-000000000000;198b13cf-5201-48e8-acef-0d8bb2d9e815",
        "correlationId": "57f825b4-a940-44a3-a3cc-25cdb9871107",
        "activityId": "01abe2fd-deee-4a47-b35f-dff3edc059a4",
        "actorCUID": "00000000-0000-0000-0000-000000000000",
        "actorUserId": "00000002-0000-8888-8000-000000000000",
        "authenticationMechanism": "",
        "timestamp": "2019-03-05T14:00:35.5034419+00:00",
        "scopeType": "organization",
        "scopeDisplayName": "fabrikam (Organization)",
        "scopeId": "73638cd5-0dda-4128-9fd6-48c16d4e4de3",
        "ipAddress": null,
        "userAgent": "",
        "actionId": "Project.CreateCompleted",
        "data": {
          "ProjectId": "2e0ffea5-d693-4711-862c-94393bacadcb",
          "ProjectName": "fabrikam-fiber-git",
          "ProcessTemplate": "Agile",
          "ProjectVisibility": "Private"
        },
        "details": "fabrikam-fiber-git project was created successfully",
        "area": "Project",
        "category": "create",
        "categoryDisplayName": "Create",
        "actorDisplayName": "Azure DevOps Service",
        "actorImageUrl": null
      }
    ],
    "continuationToken": "2518505063644965580;00000002-0000-8888-8000-000000000000;198b13cf-5201-48e8-acef-0d8bb2d9e815",
    "hasMore": false
  }
}

Definições

Nome	Description
AuditActionCategory	Tipo de ação executada
AuditLogQueryResult	O objeto retornado quando o log de auditoria é consultado. Ele contém o log e as informações necessárias para consultar mais entradas de auditoria.
AuditScopeType	O tipo do escopo (a organização só tem suporte no escopo no momento)
DecoratedAuditLogEntry

AuditActionCategory

Tipo de ação executada

Nome	Tipo	Description
access	string	Um artefato foi acessado
create	string	Um artefato foi criado
execute	string	Um artefato foi executado
modify	string	Um artefato foi modificado
remove	string	Um artefato foi removido
unknown	string	A categoria não é conhecida

AuditLogQueryResult

O objeto retornado quando o log de auditoria é consultado. Ele contém o log e as informações necessárias para consultar mais entradas de auditoria.

Nome	Tipo	Description
continuationToken	string	O token de continuação a ser passado para obter o próximo conjunto de resultados
decoratedAuditLogEntries	DecoratedAuditLogEntry[]	A lista de entradas de log de auditoria
hasMore	boolean	True quando há mais resultados correspondentes a serem buscados, caso contrário, false.

AuditScopeType

O tipo do escopo (a organização só tem suporte no escopo no momento)

Nome	Tipo	Description
deployment	string	Implantação
enterprise	string	Enterprise
organization	string	Organização
project	string	Project
unknown	string	O escopo não é conhecido ou não foi definido

DecoratedAuditLogEntry

Nome	Tipo	Description
actionId	string	A ID de ação do evento, ou seja, Git.CreateRepo, Project.RenameProject
activityId	string	ActivityId
actorCUID	string	CUID do ator
actorClientId	string	A ID do cliente do ator (se o ator for uma entidade de serviço)
actorDisplayName	string	DisplayName do usuário que iniciou a ação
actorImageUrl	string	URL da imagem de Perfil do Ator
actorUPN	string	O UPN do Ator
actorUserId	string	A ID de Usuário do Ator (se o ator for um usuário)
area	string	Área do Azure DevOps em que a ação ocorreu
authenticationMechanism	string	Tipo de autenticação usado pelo ator
category	AuditActionCategory	Tipo de ação executada
categoryDisplayName	string	DisplayName da categoria
correlationId	string	Isso permite que as entradas de auditoria relacionadas sejam agrupadas. Geralmente, isso ocorre quando uma única ação causa uma cascata de entradas de auditoria. Por exemplo, criação de projeto.
data	object	Dados externos, como CUIDs, nomes de itens etc.
details	string	Detalhes decorados
id	string	EventId – precisa ser exclusivo por serviço
ipAddress	string	Endereço IP em que o evento foi originado
projectId	string	Quando especificado, a ID do projeto à qual esse evento está associado
projectName	string	Quando especificado, o nome do projeto ao qual esse evento está associado
scopeDisplayName	string	DisplayName do escopo
scopeId	string	A ID da organização (a organização é o único escopo com suporte no momento)
scopeType	AuditScopeType	O tipo do escopo (a organização só tem suporte no escopo no momento)
timestamp	string	A hora em que o evento ocorreu em UTC
userAgent	string	O agente do usuário da solicitação