Audit Log - Query

Riferimento

Service:: Audit

API Version:: 7.1-preview.1

Query di voci del log di controllo

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path		string	Nome dell'organizzazione di Azure DevOps.
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.
batchSize	query		integer int32	Numero massimo di risultati da restituire. Facoltativo
continuationToken	query		string	Token usato per restituire il set successivo di risultati della query precedente. Facoltativo
endTime	query		string date-time	Ora di fine della finestra di download. Facoltativo
skipAggregation	query		boolean	Ignora gli eventi di aggregazione e li lascia come singole voci. Per impostazione predefinita, gli eventi vengono aggregati. Tipi di evento aggregati: AuditLog.AccessLog.
startTime	query		string date-time	Ora di inizio della finestra di download. Facoltativo

Risposte

Nome	Tipo	Descrizione
200 OK	AuditLogQueryResult	operazione riuscita

Sicurezza

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	Descrizione
vso.auditlog	Concede la possibilità di leggere il log di controllo e i flussi di controllo agli utenti

Esempio

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

Definizioni

Nome	Descrizione
AuditActionCategory	Tipo di azione eseguita
AuditLogQueryResult	Oggetto restituito quando viene eseguito una query nel log di controllo. Contiene il log e le informazioni necessarie per eseguire query su più voci di controllo.
AuditScopeType	Tipo dell'ambito (l'organizzazione è attualmente supportata solo dall'ambito)
DecoratedAuditLogEntry

AuditActionCategory

Tipo di azione eseguita

Nome	Tipo	Descrizione
access	string	È stato eseguito l'accesso a un artefatto
create	string	È stato creato un artefatto
execute	string	Un artefatto è stato eseguito
modify	string	Un elemento è stato modificato
remove	string	Un artefatto è stato rimosso
unknown	string	La categoria non è nota

AuditLogQueryResult

Oggetto restituito quando viene eseguito una query nel log di controllo. Contiene il log e le informazioni necessarie per eseguire query su più voci di controllo.

Nome	Tipo	Descrizione
continuationToken	string	Token di continuazione da passare per ottenere il set successivo di risultati
decoratedAuditLogEntries	DecoratedAuditLogEntry[]	Elenco delle voci del log di controllo
hasMore	boolean	True quando sono presenti più risultati corrispondenti da recuperare, false in caso contrario.

AuditScopeType

Tipo dell'ambito (l'organizzazione è attualmente supportata solo dall'ambito)

Nome	Tipo	Descrizione
deployment	string	Distribuzione
enterprise	string	Enterprise
organization	string	Organizzazione
project	string	Project
unknown	string	L'ambito non è noto o non è stato impostato

DecoratedAuditLogEntry

Nome	Tipo	Descrizione
actionId	string	ID azione per l'evento, ad esempio Git.CreateRepo, Project.RenameProject
activityId	string	ActivityId
actorCUID	string	CUID dell'attore
actorClientId	string	ID client dell'attore (se l'attore è un'entità servizio)
actorDisplayName	string	DisplayName dell'utente che ha avviato l'azione
actorImageUrl	string	URL dell'immagine profilo dell'attore
actorUPN	string	UPN dell'attore
actorUserId	string	ID utente dell'attore (se l'attore è un utente)
area	string	Area di Azure DevOps si è verificata l'azione
authenticationMechanism	string	Tipo di autenticazione utilizzata dall'attore
category	AuditActionCategory	Tipo di azione eseguita
categoryDisplayName	string	DisplayName della categoria
correlationId	string	Ciò consente di raggruppare le voci di controllo correlate. In genere si verifica quando una singola azione causa una cascata di voci di controllo. Ad esempio, la creazione del progetto.
data	object	Dati esterni, ad esempio CUID, nomi di elementi e così via.
details	string	Dettagli decorati
id	string	EventId - Deve essere univoco per servizio
ipAddress	string	Indirizzo IP in cui è stato originato l'evento
projectId	string	Se specificato, l'ID del progetto a cui è associato questo evento
projectName	string	Se specificato, il nome del progetto a cui è associato questo evento
scopeDisplayName	string	DisplayName dell'ambito
scopeId	string	ID organizzazione (organizzazione è l'unico ambito attualmente supportato)
scopeType	AuditScopeType	Tipo dell'ambito (l'organizzazione è attualmente supportata solo dall'ambito)
timestamp	string	Ora in cui si è verificato l'evento in formato UTC
userAgent	string	Agente utente dalla richiesta

Share via