감사 API
감사 API를 이용하여 날짜 필터, 정렬 메커니즘 및 페이지 매김에 대해 주어진 입력 조합에 대한 감사 데이터를 요청합니다.
전제 조건
주: Community Edition에서 Control Room APIs을 볼 수 있지만, API 기능은 제한됩니다. API의 전체 기능에 액세스하려면 라이선스가 인가된 Automation 360 에디션이 필요합니다.
- 인증 API를 이용하여 JSON 웹 토큰을 생성합니다. 인증 API를 참고하십시오.
- AAE_Admin 역할 또는 모든 감사 로그 보기 작업 권한이 있는 사용자는 Control Room에 대한 감사 로그를 볼 수 있습니다.
프로시저
- 인증 API를 이용하여 JSON 웹 토큰을 생성합니다. 인증 API를 참고하십시오.
-
필터를 적용하여 웹페이지를 처리하기 위한 기본 조건부 쿼리 및 페이지 매김 제어 기능을 수행합니다.
필터링과 관련된 세 가지 기본 기능으로 필터링 조건, 열 정렬 및 페이지 매김 매개변수가 있습니다.
-
POST 메소드 및 엔드포인트 URL 이용:
<your_control_room_url>/v1/audit/messages/list
.다음 예에서는 2019년 12월 한 달 동안 로그인 시도에 실패한 데이터를 요청하게 됩니다.요청 본문:
{ "sort": [ { "field": "createdOn", "direction": "desc" } ], "filter": { "operator": "and", "operands": [ { "operator": "gt", "field": "createdOn", "value": "2019-12-01T00:00:00.001Z" }, { "operator": "lt", "field": "createdOn", "value": "2019-12-31T23:59:59.999Z" }, { "operator": "eq", "field": "status", "value": "Unsuccessful" }, { "operator": "substring", "field": "activityType", "value": "LOGIN" }, { "operator": "substring", "field": "userName", "value": "joe.typical@myemiil.com" } ] }, "fields": [], "page": { "length": "1000", "offset": "0" } }
-
요청 전송.
이 예시에서의 응답은 날짜 필터, 정렬 및 페이지 매김에 대한 데이터를 반환합니다. 요청에 필터링이 이용되지 않았을 때는 응답이 성공적이면 지정된 Control Room에 대하여 모든 페이지를 반환합니다.응답 본문:
{ "page": { "offset": 0, "total": 731064850, "totalFilter": 9 }, "list": [ { "id": "XlHj6G4BFXSpOOji5B7S", "eventDescription": "User does not exist in Control Room.", "activityType": "LOGIN", "environmentName": "", "hostName": "12.xxx.xx.x", "userName": "joe.typical@myemiil.com", "status": "Unsuccessful", "source": "Control Room", "objectName": "N/A", "detail": "", "createdOn": "2019-12-09T04:21:19Z", "requestId": "04965c2e-82e0-4ce4-a88d-bebe1dc3a2a8", "createdBy": "0" }, { "id": "g1Hj6G4BFXSpOOji2Rwx", "eventDescription": "User does not exist in Control Room.", "activityType": "LOGIN", "environmentName": "", "hostName": "12.xxx.xx.x", "userName": "joe.typical@myemiil.com", "status": "Unsuccessful", "source": "Control Room", "objectName": "N/A", "detail": "", "createdOn": "2019-12-09T04:21:16Z", "requestId": "61672553-477d-4012-ab47-2a27f6553c4e", "createdBy": "0" }, .............................. { "id": "ETyk6G4BFXSpOOjiaJjt", "eventDescription": "User does not exist in Control Room.", "activityType": "LOGIN", "environmentName": "", "hostName": "12.xxx.xx.x", "userName": "joe.typical@myemiil.com", "status": "Unsuccessful", "source": "Control Room", "objectName": "N/A", "detail": "", "createdOn": "2019-12-09T03:11:58Z", "requestId": "ebeb01de-1f81-4a7c-8978-405806e146bd", "createdBy": "0" } ] }
REST API는 HTTP 응답 코드를 이용하여 각 요청에 응답합니다.
응답 코드는 API 응답 코드를 참고하십시오.