監査データのダウンロード

GET/audits/logs/download

監査ログをCSV形式でダウンロードするためのURLを取得する。 対象ドメインの最高管理者、副管理者またはService Accountのみ利用可能。

注意

  • 監査データのダウンロード API は並行して呼び出さないでください。
  • ダウンロード中にエラーが発生した場合、ファイルの最後尾に「downloadLogs error」 とエラーメッセージが出力されます。
  • リダイレクトされたURLは、一定期間を過ぎると無効になります。最新のダウンロードURLを取得してください。

Authorization

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

HTTP Request

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

Query Parameters

ParameterTypeDescription
servicestring

監査ログのサービスタイプ

  • admin: 管理者画面
  • board: 掲示板
  • bot: BotAPI
  • drive: Drive
  • calendar: カレンダー
  • contact: アドレス帳
  • task: タスク
  • form: アンケート
  • share: 画面共有
  • note: ノート
  • received-mail: メール受信
  • sent-mail: メール受信
  • deleted-mail: メール削除
  • message: トーク
  • call: 通話
  • template: テンプレート
  • mobile-capture: モバイルデバイスでのスクリーンショット
  • developer: Developer Console
  • auth: ログイン
  • file-download : ファイル

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

取得開始日 (YYYY-MM-DDThh:mm:ssTZD)
開始日から終了日までの取得期間は最長31日まで設定可。
URLエンコードする。(+ → %2B)


required
example : 2021-11-01T00:00:00%2B09:00
endTimestring

取得終了日 (YYYY-MM-DDThh:mm:ssTZD)
開始日から終了日までの取得期間は最長31日まで設定可。
URLエンコードする。(+ → %2B)


required
example : 2021-11-30T23:59:59%2B09:00
languagestring

ダウンロードするCSVファイルの言語


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

Botトークメッセージフィルタータイプ

  • include: 含める
  • exclude: 除く
  • only: Botのメッセージのみ

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

ドメインID (グループ企業の場合、別のドメインのログを取得する場合に指定する)


example : 10000001
format : int32

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required

Response

HTTP 302

Found - LocationヘッダーのダウンロードURLにリダイレクト