Audit Log - Query

  • Referensi
Service:
Audit
API Version:
7.1-preview.1

Kueri entri log audit

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
organization
 path

string

Nama organisasi Azure DevOps.
api-version
 query True

string

Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini.
batchSize
 query

integer

int32

Jumlah maksimum hasil yang akan dikembalikan. Opsional
continuationToken
 query

string

Token yang digunakan untuk mengembalikan kumpulan hasil berikutnya dari kueri sebelumnya. Opsional
endTime
 query

string

date-time

Waktu akhir jendela unduhan. Opsional
skipAggregation
 query

boolean

Lewati agregasi peristiwa dan biarkan sebagai entri individual sebagai gantinya. Secara default peristiwa diagregasi. Jenis peristiwa yang diagregasi: AuditLog.AccessLog.
startTime
 query

string

date-time

Waktu mulai jendela unduhan. Opsional

Respons

Nama Jenis Deskripsi
200 OK

AuditLogQueryResult

operasi berhasil

Keamanan

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

Nama Deskripsi
vso.auditlog Memberikan kemampuan untuk membaca log audit dan aliran audit kepada pengguna

Contoh

By date

Sample Request

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

Definisi

Nama Deskripsi
AuditActionCategory

Jenis tindakan yang dijalankan
AuditLogQueryResult

Objek dikembalikan ketika log audit dikueri. Ini berisi log dan informasi yang diperlukan untuk mengkueri lebih banyak entri audit.
AuditScopeType

Jenis cakupan (Organisasi hanya lingkup yang saat ini didukung)
DecoratedAuditLogEntry

AuditActionCategory

Jenis tindakan yang dijalankan

Nama Jenis Deskripsi
access

string

Artefak telah Diakses
create

string

Artefak telah Dibuat
execute

string

Artefak telah Dieksekusi
modify

string

Artefak telah Dimodifikasi
remove

string

Artefak telah Dihapus
unknown

string

Kategori tidak diketahui

AuditLogQueryResult

Objek dikembalikan ketika log audit dikueri. Ini berisi log dan informasi yang diperlukan untuk mengkueri lebih banyak entri audit.

Nama Jenis Deskripsi
continuationToken

string

Token kelanjutan yang akan diteruskan untuk mendapatkan serangkaian hasil berikutnya
decoratedAuditLogEntries

DecoratedAuditLogEntry[]

Daftar entri log audit
hasMore

boolean

Benar ketika ada lebih banyak hasil yang cocok untuk diambil, salah jika tidak.

AuditScopeType

Jenis cakupan (Organisasi hanya lingkup yang saat ini didukung)

Nama Jenis Deskripsi
deployment

string

Penyebaran
enterprise

string

Perusahaan
organization

string

Organisasi
project

string

Project
unknown

string

Cakupan tidak diketahui atau belum disetel

DecoratedAuditLogEntry

Nama Jenis Deskripsi
actionId

string

Id tindakan untuk peristiwa tersebut, yaitu Git.CreateRepo, Project.RenameProject
activityId

string

ActivityId
actorCUID

string

CUID Aktor
actorClientId

string

Id Klien Actor (jika actor adalah perwakilan layanan)
actorDisplayName

string

DisplayName pengguna yang memulai tindakan
actorImageUrl

string

URL gambar Profil Aktor
actorUPN

string

UPN Aktor
actorUserId

string

Id Pengguna Actor (jika actor adalah pengguna)
area

string

Area Azure DevOps tindakan terjadi
authenticationMechanism

string

Jenis autentikasi yang digunakan oleh aktor
category

AuditActionCategory

Jenis tindakan yang dijalankan
categoryDisplayName

string

DisplayName kategori
correlationId

string

Ini memungkinkan entri audit terkait dikelompokkan bersama. Umumnya ini terjadi ketika satu tindakan menyebabkan kaskade entri audit. Misalnya, pembuatan proyek.
data

object

Data eksternal seperti CUID, nama item, dll.
details

string

Detail yang didekorasi
id

string

EventId - Harus unik per layanan
ipAddress

string

Alamat IP tempat peristiwa berasal
projectId

string

Ketika ditentukan, id proyek yang dikaitkan dengan kejadian ini
projectName

string

Ketika ditentukan, nama proyek yang dikaitkan dengan kejadian ini
scopeDisplayName

string

DisplayName dari cakupan
scopeId

string

Id organisasi (Organisasi adalah satu-satunya cakupan yang saat ini didukung)
scopeType

AuditScopeType

Jenis cakupan (Organisasi hanya lingkup yang saat ini didukung)
timestamp

string

Waktu ketika peristiwa terjadi di UTC
userAgent

string

Agen pengguna dari permintaan