Audit Log - Query

Reference

Service:: Audit

API Version:: 7.1-preview.1

Dotazy na položky protokolu auditu

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path		string	Název organizace Azure DevOps.
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.
batchSize	query		integer int32	Maximální počet vrácených výsledků Volitelné
continuationToken	query		string	Token použitý k vrácení další sady výsledků z předchozího dotazu. Volitelné
endTime	query		string date-time	Čas ukončení okna stahování. Volitelné
skipAggregation	query		boolean	Přeskočí agregaci událostí a místo toho je ponechá jako jednotlivé položky. Ve výchozím nastavení se události agregují. Agregované typy událostí: AuditLog.AccessLog.
startTime	query		string date-time	Čas zahájení okna stahování. Volitelné

Odpovědi

Name	Typ	Description
200 OK	AuditLogQueryResult	úspěšná operace

Zabezpečení

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

Name	Description
vso.auditlog	Uděluje uživatelům možnost číst protokol auditování a streamy auditu.

Příklady

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

Definice

Name	Description
AuditActionCategory	Typ provedené akce
AuditLogQueryResult	Objekt vrácený při dotazování na protokol auditu. Obsahuje protokol a informace potřebné k dotazování na další položky auditu.
AuditScopeType	Typ oboru (organizace je aktuálně podporovaný pouze obor)
DecoratedAuditLogEntry

AuditActionCategory

Typ provedené akce

Name	Typ	Description
access	string	Přístup k artefaktu
create	string	Artefakt byl vytvořen.
execute	string	Artefakt byl proveden.
modify	string	Artefakt byl změněn.
remove	string	Artefakt byl odebrán.
unknown	string	Kategorie není známa.

AuditLogQueryResult

Objekt vrácený při dotazování na protokol auditu. Obsahuje protokol a informace potřebné k dotazování na další položky auditu.

Name	Typ	Description
continuationToken	string	Token pokračování, který se má předat, aby se získala další sada výsledků
decoratedAuditLogEntries	DecoratedAuditLogEntry[]	Seznam položek protokolu auditu
hasMore	boolean	True, pokud je k dispozici více odpovídajících výsledků, které se mají načíst, jinak false.

AuditScopeType

Typ oboru (organizace je aktuálně podporovaný pouze obor)

Name	Typ	Description
deployment	string	Nasazení
enterprise	string	Enterprise
organization	string	Organizace
project	string	Project
unknown	string	Obor není známý nebo nebyl nastaven.

DecoratedAuditLogEntry

Name	Typ	Description
actionId	string	ID akce události, tj. Git.CreateRepo, Project.RenameProject
activityId	string	ID aktivity
actorCUID	string	CUID objektu actor
actorClientId	string	ID klienta objektu Actor (pokud je objektem služby actor)
actorDisplayName	string	DisplayName uživatele, který akci inicioval
actorImageUrl	string	Adresa URL obrázku profilu objektu actor
actorUPN	string	Hlavní název uživatele (UPN) objektu Actor
actorUserId	string	ID uživatele objektu Actor (pokud je objekt actor uživatelem)
area	string	V oblasti Azure DevOps došlo k akci
authenticationMechanism	string	Typ ověřování používaného objektem actor
category	AuditActionCategory	Typ provedené akce
categoryDisplayName	string	DisplayName kategorie
correlationId	string	To umožňuje seskupit související položky auditu. Obecně k tomu dochází, když jedna akce způsobí kaskádu položek auditu. Například vytvoření projektu.
data	object	Externí data, jako jsou CUID, názvy položek atd.
details	string	Zdobené detaily
id	string	EventId – musí být jedinečné pro každou službu.
ipAddress	string	IP adresa, ze které událost pochází
projectId	string	Pokud je zadáno, ID projektu, ke který je tato událost přidružena
projectName	string	Pokud je zadán název projektu, ke které je tato událost přidružena
scopeDisplayName	string	DisplayName oboru
scopeId	string	ID organizace (organizace je jediný aktuálně podporovaný obor)
scopeType	AuditScopeType	Typ oboru (organizace je aktuálně podporovaný pouze obor)
timestamp	string	Čas, kdy k události došlo v UTC
userAgent	string	Uživatelský agent z požadavku

Sdílet prostřednictvím