監査 API の概要

    LINE WORKS は LINE WORKS の監査機能の主な機能を API で提供しています。 LINE WORKS 監査 API は、HTTP リクエストで利用することができ、API の結果は JSON 形式で返すか、ファイルダウンロードの形で提供しています。

    API の種類

    監査 API ではサーバー API のみ提供されます。 (API 概要参照)

    環境

    監査 API はサービス環境でのみ利用できます。

    サービス環境: https://audit.worksmobile.com
    オペレーションをリクエストする場合は HTTP メソッドとリクエスト URL を組み合わせます。例えば、Drive の監査ログをダウンロードするオペレーションは以下のようになります。

    例) 監査ダウンロード API

    GET https://audit.worksmobile.com/r/kr1jJQFeYUdDn/audit/v2/log/message/logs.csv?rangeName=domain&startDate=20201028&endDate=20201028&tenantId=7&domainId=7&serviceId=audit&apiId=downCsvLog
    

    リクエスト URL は、各 API の操作についてのページを確認してください。

    Request 共通

    LINE WORKS Access Token と Consumer Key

    API を呼び出す場合は、必ずヘッダーに LINE WORKS Access Token と Consumer Key を記載する必要があります。

    Token および Key の発行は API 共通ガイド の「サーバー API の認証」を参照してください。

    ヘッダーに Access Token と Consumer Key を設定する方法は、以下の通りです。

    httpMethod.setRequestHeader("Authorization",Bearer "LINE WORKS Access Token"); httpMethod.setRequestHeader("consumerKey", "Consumer Key");

    また、下記の共通パラメータをクエリに含めます。その他クエリの詳細は各操作に関するページを確認してください。

    共通パラメーター

    パラメーター
    タイプ
    必須
    説明
    値 (例)
    apiId
    String
    Y API の区分 ID downCsvLog (監査ログのダウンロードの場合)
    serviceId
    String
    Y サービス ID audit (監査は audit で固定)