감사 로그는 다양한 서비스 및 기능에 대한 사용자 활동의 세부 정보를 제공하는 데 사용됩니다. 로그에 기록된 각 작업에는 작업 유형, 날짜 및 시간, 작업을 수행한 사용자의 이메일 ID 및 작업 유형과 관련된 추가 속성을 나타내는 메타데이터가 포함됩니다. 다음 /audit/events
의 엔드포인트 Audit Query API를 사용하면 의 조직 활동에 대한 이벤트 데이터를 프로그래밍 방식으로 검색할 수 있습니다 Platform.
이 안내서에 사용된 API 끝점은 Audit Query API. 계속하기 전에 다음을 검토하십시오. 시작 안내서 관련 설명서에 대한 링크, 이 문서에서 샘플 API 호출 읽기에 대한 안내서 및 를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보 Experience Platform API.
에 GET 요청을 하여 이벤트 데이터를 검색할 수 있습니다. /audit/events
페이로드에서 검색할 이벤트를 지정하는 엔드포인트.
API 형식
GET /audit/events
다음 Audit Query API는 이벤트를 나열할 때 페이지 및 필터 결과에 대한 쿼리 매개 변수의 사용을 지원합니다.
매개변수 | 설명 |
---|---|
limit |
응답에서 반환할 최대 레코드 수입니다. 기본값 limit 는 50입니다. |
start |
반환된 검색 결과의 첫 번째 항목에 대한 포인터입니다. 다음 결과 페이지에 액세스하려면 이 매개 변수는 제한으로 표시된 것과 동일한 양만큼 증가해야 합니다. 예: limit=50인 요청에 대한 다음 결과 페이지에 액세스하려면 매개 변수 start=50을 사용한 다음 그 다음 페이지에 대해 start=100을 사용하는 등의 작업을 수행합니다. |
queryId |
/audit/events 끝점에 쿼리할 때 응답에는 queryId 문자열 속성이 포함됩니다. 별도의 호출에서 동일한 쿼리를 만들려면 검색 매개 변수를 다시 수동으로 구성하는 대신 ID 값을 단일 쿼리 매개 변수로 포함할 수 있습니다. |
요청
curl -X POST \
https://platform.adobe.io/data/foundation/audit/events?limit=10
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-request-id: {TRACING_ID}' \
응답
성공적인 응답은 요청에 지정된 지표 및 필터에 대한 결과 데이터 포인트를 반환합니다.
{
"_embedded": {
"customerAuditLogList": [
{
"userEmail": "{USER_ID}",
"userIpAddresses": [ ],
"eventType": "Core",
"id": "32b72208-3035-4bc6-b434-39e34401a864",
"version": "1.0",
"imsOrgId": "{ORGANIZATION_ID}",
"sandboxName": "prod",
"region": "VA7",
"requestId": "5NphpgUQdQnjTWOcS9DSMs2wD1EUMlYG",
"authId": "96715f98-d100-4575-8491-ebbcea654eb9",
"permissionResource": "Sandbox",
"permissionType": "RESET",
"assetType": "Sandbox",
"assetId": "prod",
"assetName": "prod",
"action": "Reset",
"status": "Allow",
"failureCode": "",
"timestamp": "2021-08-04T21:58:09.745+0000"
},
{
"userEmail": "{USER_ID}",
"userIpAddresses": [ ],
"eventType": "Core",
"id": "a178736a-8fa1-47da-bac5-b0d9e741e414",
"version": "1.0",
"imsOrgId": "{ORGANIZATION_ID}",
"sandboxName": "prod",
"region": "VA7",
"requestId": "7AlGIAhWvaEzYWHLzvuf26AAFAkqSyKg",
"authId": "60fc1077-4aef-4e1f-a5ff-f64183e060f4",
"permissionResource": "Sandbox",
"permissionType": "RESET",
"assetType": "Sandbox",
"assetId": "prod",
"assetName": "prod",
"action": "Reset",
"status": "Allow",
"failureCode": "",
"timestamp": "2021-08-04T21:28:00.301+0000"
},
{
"userEmail": "{USER_ID}",
"userIpAddresses": [ ],
"eventType": "Core",
"id": "ccfe8c77-9b93-481d-a561-0b2edf3b77dc",
"version": "1.0",
"imsOrgId": "{ORGANIZATION_ID}",
"sandboxName": "prod",
"region": "VA7",
"requestId": "hArqS4CAa8wfRPnKuxV4yaA82atxwzYu",
"authId": "80b7d887-9338-4cd5-9d79-2483b03f0160",
"permissionResource": "Sandbox",
"permissionType": "RESET",
"assetType": "Sandbox",
"assetId": "prod",
"assetName": "prod",
"action": "Reset",
"status": "Allow",
"failureCode": "",
"timestamp": "2021-08-04T20:58:07.750+0000"
}
]
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/audit/events?limit=10&start=0&property=type%253D%253Dcore"
},
"next": {
"href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&start=10&limit=10"
},
"page": {
"href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&limit=10{&start}",
"templated": true
}
},
"page": {
"size": 10,
"totalElements": 3,
"totalPages": 1,
"number": 1
},
"queryId": "cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2"
}
속성 | 설명 |
---|---|
customerAuditLogList |
개체가 요청에 지정된 각 이벤트를 나타내는 배열입니다. 각 개체에는 필터 구성 및 반환된 이벤트 데이터에 대한 정보가 들어 있습니다. |
userEmail |
이벤트를 수행한 사용자의 이메일입니다. |
eventType |
이벤트 유형. 이벤트 유형은 다음과 같습니다 Core 및 Enhanced . |
imsOrgId |
이벤트가 발생한 조직의 ID입니다. |
permissionResource |
권한을 제공한 제품 또는 기능이 작업을 수행합니다. 리소스는 다음 중 하나일 수 있습니다.
|
permissionType |
작업과 관련된 권한 유형입니다. |
assetType |
작업이 수행된 플랫폼 리소스의 유형입니다. |
assetId |
작업이 수행된 Platform 리소스에 대한 고유 식별자입니다. |
assetName |
작업이 수행된 Platform 리소스의 이름입니다. |
action |
이벤트에 대해 기록된 작업 유형입니다. 작업은 다음 중 하나일 수 있습니다.
|
status |
작업의 상태입니다. 상태는 다음 중 하나일 수 있습니다. Allow Deny Failure Success |