Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

감사 로그 파일 목록(List Log Files) (V2)

조직에 속한 감사 로그 파일의 ID 목록을 날짜 범위로 조회합니다. pageToken이 없는 첫 요청에는 startDate가 필수입니다. endDate는 해당 날짜를 포함하며, 생략하면 종료 날짜를 제한하지 않습니다. 날짜는 YYYY-MM-DD 형식으로 지정합니다.

각 페이지의 결과 수는 요청한 pageSize보다 작거나 클 수 있습니다. 결과가 더 있으면 nextPageToken이 제공되므로, 결과 수 대신 이 필드로 다음 페이지 여부를 판단합니다. 다음 요청은 같은 조회 조건에 직전 응답의 토큰을 pageToken으로 넣습니다. 응답에 다음 토큰이 없으면 마지막 페이지입니다.

종료 날짜를 지정하지 않은 조회에서는 반환한 토큰으로 새로 제공되는 로그를 계속 확인할 수 있습니다. 개별 파일의 본문은 Get Log File Content로 내려받습니다.

HTTP 요청

GET /api/v2/audit/organizations/{organizationRid}/logFiles

작업 식별자는 v2.listLogFiles입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:audit-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
organizationRidstring필수ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
startDatestring (date)선택이 날짜부터 발생한 감사 이벤트의 로그 파일을 조회합니다. pageToken이 없는 첫 요청에서는 필수입니다.2024-01-01
endDatestring (date)선택이 날짜까지의 감사 이벤트를 포함하여 조회합니다. 생략하면 종료 날짜를 제한하지 않습니다. 반환한 nextPageToken으로 List Log Files를 계속 조회하여 새로 제공되는 로그를 확인할 수 있습니다.2025-01-01
pageSizeinteger선택요청할 페이지 크기입니다.
pageTokenstring선택페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다.

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListLogFilesResponse입니다.

이름자료형필수 여부의미와 조건예시 값
datalist<LogFile>선택
nextPageTokenstring선택다음 페이지를 요청할 때 pageToken에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

data의 구조

배열 항목은 LogFile이며 자료형은 object입니다.

이름자료형필수 여부의미와 조건예시 값
idstring필수감사 로그 파일의 ID입니다.S2VlcEV4cGxvcmluZw==

가상 감사 로그 파일 목록의 응답 예시입니다.

{
  "data": [
    {
      "id": "S2VlcEV4cGxvcmluZw=="
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
ListLogFilesPermissionDeniedPERMISSION_DENIED403호출 토큰에 감사 로그 파일 목록을 조회할 권한이 없습니다.
MissingStartDateINVALID_ARGUMENT400감사 로그 파일을 조회하려면 시작 날짜가 필요합니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/audit/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/logFiles?startDate=2024-01-01&endDate=2025-01-01"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/audit/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/logFiles?startDate=2024-01-01&endDate=2025-01-01'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListLogFilesExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class ListLogFilesExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/audit/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/logFiles?startDate=2024-01-01&endDate=2025-01-01");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/audit/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/logFiles?startDate=2024-01-01&endDate=2025-01-01`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/audit/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/logFiles?startDate=2024-01-01&endDate=2025-01-01" `
	-Headers $headers

$response.content