[プレビュー] 監査ログを取得する

組織名に基づいて、組織の監査ログを取得します。

API エンドポイント

https://{yourDomain}/audit_/api/auditlogs

スコープ

次のスコープが必要です。

• PM.Audit
• PM.Audit.Read

要求ヘッダー

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

注: {access_token} を取得するには、必ずこちらで説明するいずれかの方法で認証を行ってください。

Query Parameters

クエリ パラメーター	データ型	説明
language (任意)	string	利用可能な表示言語を短い形式で指定します。 たとえば、en、fr、de、ja などです。
top (任意)	int32	監査の上位 N 件のエントリを表示します。
skip (任意)	int32	上位 N 件の監査エントリの表示をスキップします。
sortBy (任意)	string	監査エントリの並べ替え条件として使用する DTO プロパティを指定します。 たとえば、createdOn、category、email などです。
sortOrder (任意)	string	並べ替え順序を指定します。 たとえば、昇順 (asc) または降順 (desc) です。
api-version (任意)	string	使用している API バージョンを指定します。

応答

200 OK

クエリが実行された監査イベントを返します。

要求の例

API 呼び出しの構築に必要な情報をすべて収集したとします。

• {baseURL} は https://{yourDomain}/{organizationName}/{tenantName}/ です。
• {access_token} は 1234 です (長さを考慮)。

• 以下のクエリ パラメーターを設定します。

  • language = en
  • top = 2。上位 2 件のエントリを表示します。
  • skip = 2。最初の 2 件のエントリをスキップします。
  • sortBy = createdOn。エントリを作成日時で並べ替えます。
  • sortOrder = asc。エントリを最も古いものから最も新しいものの順に並べ替えます。

呼び出しは以下のようになります (cURL)。

curl --location --request GET '
				https://{yourDomain}/{organizationName}/{tenantName}/audit_/api/auditlogs/?language=en&top=2&skip=2&sortBy=createdOn&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

監査エントリが正常に取得された場合、応答本文は次のようになります。

{
    "totalCount": 29,
    "results": [
        {
            "createdOn": "2021-10-14T13:10:15.1964174+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        },
....
        {
            "createdOn": "2021-10-14T12:41:00.3268964+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        }
    ]
}