감사 로그 다운로드

GET/audits/logs/download

감사 데이터 파일을 CSV 형식으로 다운로드한다.

대상 도메인에 대한 최고관리자, 부관리자 권한이 있는 사용자이거나 서비스 계정일 경우에만 이용 가능하다.

감사로그 다운로드는 모든 사용자의 형평성있는 서비스 제공을 위해서 동시 요청(Concurrent Request)을 제한하고 있습니다. 그래서 한 번 다운로드 요청을 한 후 그 응답이 완료된 후에 다음 요청을 해주시기 바랍니다.

주의

  • 최근 6개월 까지의 감사 로그를 조회할 수 있다.
  • 다운로드 중에 오류가 발생하면 파일 마지막에 "downloadLogs error" 이후 오류 메시지가 출력된다.
  • 리다이렉트된 파일 다운로드 URL은 일정 기간 경과시 사용할 수 없으므로 최신 다운로드 URL을 사용한다.

Authorization

oauth2

oauth2인증, 자세한 내용은 문서를 참조한다

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

audit.read
audit

HTTP Request

GEThttps://www.worksapis.com/v1.0/audits/logs/download

Query Parameters

ParameterTypeDescription
servicestring

로그를 조회할 대상 서비스.
admin, auth, board, bot, drive, calendar, contact, form, share, note, received-mail, sent-mail, deleted-mail, message, message-join-exit, developer, template, task, call, mobile-capture, file-download


required
Allowed values : admin, board, bot, drive, calendar, contact, task, form, share, note, received-mail, sent-mail, deleted-mail, message, message-join-exit, call, template, mobile-capture, developer, auth, file-download
startTimestring

YYYY-MM-DDThh:mm:ssTZD 형식의 감사 데이터 조회 시작일.
- 시작일에서 종료일까지 조회 기간은 최대 31일.
- 「+」는 「%2B」로 인코딩해야 한다.


required
example : 2021-05-01T00:00:00+01:00
endTimestring

YYYY-MM-DDThh:mm:ssTZD 형식의 감사 데이터 조회 종료일.
- 시작일에서 종료일까지 조회 기간은 최대 31일.
- 「+」는 「%2B」로 인코딩해야 한다.


required
example : 2021-05-31T23:59:59+01:00
languagestring

다운로드하는 Excel 파일의 표시 언어


default : en_US
Allowed values : ko_KR, ja_JP, zh_CN, zh_TW, en_US
botMessageFilterTypestring

메시지 로그에서만 사용. Bot 메시지의 포함 여부를 결정한다.
• include: 포함 • exclude: 제외 • only: Bot 메시지만


default : include
Allowed values : include, exclude, only
domainIdinteger

도메인 ID
• 기본값: 조회하는 계정의 도메인 ID


example : 10000001
format : int32

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required

Response

HTTP 302

location 헤더에 파일 접근 URL이 포함되어 반환된다.