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

Предприятие
organization

string

План
project

string

Project
unknown

string

Область не известна или не задана

DecoratedAuditLogEntry

Имя Тип Описание
actionId

string

Идентификатор действия для события, например Git.CreateRepo, Project.RenameProject
activityId

string

ActivityId
actorCUID

string

CUID субъекта
actorClientId

string

Идентификатор клиента субъекта (если субъект является субъектом-службой)
actorDisplayName

string

DisplayName пользователя, инициировавшего действие
actorImageUrl

string

URL-адрес изображения профиля субъекта
actorUPN

string

Имя участника-пользователя субъекта
actorUserId

string

Идентификатор пользователя субъекта (если субъект является пользователем)
area

string

Область Azure DevOps, где произошло действие
authenticationMechanism

string

Тип проверки подлинности, используемый субъектом
category

AuditActionCategory

Тип выполняемого действия
categoryDisplayName

string

DisplayName категории
correlationId

string

Это позволяет сгруппировать связанные записи аудита. Обычно это происходит, когда одно действие вызывает каскад записей аудита. Например, создание проекта.
data

object

Внешние данные, такие как идентификаторы CUID, имена элементов и т. д.
details

string

Декорированные детали
id

string

EventId — должен быть уникальным для каждой службы.
ipAddress

string

IP-адрес, на котором возникло событие
projectId

string

Если этот параметр задан, идентификатор проекта, с который связано это событие.
projectName

string

При указании имя проекта, с чем связано это событие.
scopeDisplayName

string

DisplayName область
scopeId

string

Идентификатор организации (организация является единственной поддерживаемой область в настоящее время)
scopeType

AuditScopeType

Тип область (организация поддерживается только область в настоящее время)
timestamp

string

Время возникновения события в формате UTC
userAgent

string

Агент пользователя из запроса