Audit Log - Query

  • リファレンス
Service:
Audit
API Version:
7.1-preview.1

クエリ監査ログ エントリ

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

URI パラメーター

名前 / 必須 型 説明
organization
 path

string

Azure DevOps 組織の名前です。
api-version
 query True

string

使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
batchSize
 query

integer

int32

返される結果の最大数。 オプション
continuationToken
 query

string

前のクエリから次の結果セットを返す場合に使用されるトークン。 オプション
endTime
 query

string

date-time

ダウンロード期間の終了時刻。 オプション
skipAggregation
 query

boolean

イベントの集計をスキップし、代わりに個々のエントリとして残します。 既定では、イベントは集計されます。 集計されるイベントの種類: AuditLog.AccessLog。
startTime
 query

string

date-time

ダウンロード期間の開始時刻。 オプション

応答

名前 型 説明
200 OK

AuditLogQueryResult

成功した操作

セキュリティ

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

名前 説明
vso.auditlog 監査ログと監査ストリームをユーザーに読み取る機能を付与します

例

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

定義

名前 説明
AuditActionCategory

実行されるアクションの種類
AuditLogQueryResult

監査ログの照会時に返される オブジェクト。 これには、ログと、より多くの監査エントリのクエリに必要な情報が含まれています。
AuditScopeType

スコープの種類 (組織は現在サポートされているスコープのみです)
DecoratedAuditLogEntry

AuditActionCategory

実行されるアクションの種類

名前 型 説明
access

string

成果物にアクセスしました
create

string

成果物が作成されました
execute

string

成果物が実行されました
modify

string

成果物が変更されました
remove

string

成果物が削除されました
unknown

string

カテゴリが不明です

AuditLogQueryResult

監査ログの照会時に返される オブジェクト。 これには、ログと、より多くの監査エントリのクエリに必要な情報が含まれています。

名前 型 説明
continuationToken

string

次の結果セットを取得するために渡す継続トークン
decoratedAuditLogEntries

DecoratedAuditLogEntry[]

監査ログ エントリの一覧
hasMore

boolean

フェッチする一致する結果がさらに存在する場合は True、それ以外の場合は false。

AuditScopeType

スコープの種類 (組織は現在サポートされているスコープのみです)

名前 型 説明
deployment

string

デプロイ
enterprise

string

Enterprise
organization

string

組織
project

string

Project
unknown

string

スコープが不明であるか、設定されていません

DecoratedAuditLogEntry

名前 型 説明
actionId

string

イベントのアクション ID (Git.CreateRepo、Project.RenameProject など)
activityId

string

ActivityId
actorCUID

string

アクターの CUID
actorClientId

string

アクターのクライアント ID (アクターがサービス プリンシパルの場合)
actorDisplayName

string

アクションを開始したユーザーの DisplayName
actorImageUrl

string

アクターのプロファイル 画像の URL
actorUPN

string

アクターの UPN
actorUserId

string

アクターのユーザー ID (アクターがユーザーの場合)
area

string

アクションが発生した Azure DevOps の領域
authenticationMechanism

string

アクターによって使用される認証の種類
category

AuditActionCategory

実行されるアクションの種類
categoryDisplayName

string

カテゴリの DisplayName
correlationId

string

これにより、関連する監査エントリをグループ化できます。 通常、これは、1 つのアクションによって監査エントリが連鎖する場合に発生します。 たとえば、プロジェクトの作成です。
data

object

CUID、アイテム名などの外部データ。
details

string

装飾の詳細
id

string

EventId - サービスごとに一意である必要がある
ipAddress

string

イベントが発生した IP アドレス
projectId

string

指定すると、このイベントが関連付けられているプロジェクトの ID
projectName

string

指定した場合、このイベントが関連付けられているプロジェクトの名前
scopeDisplayName

string

スコープの DisplayName
scopeId

string

organization ID (現在サポートされているスコープは Organization のみです)
scopeType

AuditScopeType

スコープの種類 (組織は現在サポートされているスコープのみです)
timestamp

string

イベントが UTC で発生した時刻
userAgent

string

要求からのユーザー エージェント