reportRoot: getCredentialUsageSummary

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

セルフサービス パスワード リセット機能を使用した組織内のユーザーの数の現在の状態を報告します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Reports.Read.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Reports.Read.All 注意事項なし。

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーがグループの所有者またはメンバーであるか、サポートされている Microsoft Entra ロール またはサポートされているロールのアクセス許可を持つカスタム ロールが割り当てられている必要があります。 この操作では、次の最小特権ロールがサポートされています。

  • レポート閲覧者
  • セキュリティ閲覧者
  • セキュリティ管理者
  • グローバル閲覧者

HTTP 要求

GET /reports/getCredentialUsageSummary(period='{periodValue}')

関数パラメーター

応答の時間枠を要求するには、次の関数パラメーターを使用する必要があります。

パラメーター 説明
period String 必須です。 使用状況データが必要な期間を日数で指定します。 例: /reports/getCredentialUsageSummary(period='D30')。 サポートされている期間: D1D7D30。 ピリオドでは大文字と小文字が区別されません。

オプションのクエリ パラメーター

この関数は、省略可能な OData クエリ パラメーター $filterをサポートします。 credentialUsageSummary リソースの次のプロパティの 1 つ以上に$filterを適用できます。

プロパティ 説明と例
特徴 必要な使用状況データの種類を指定します (登録とリセット)。 例: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'。 サポートされているフィルター演算子: eq

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは応答コード 200 OK と、応答本文に新しい credentialUsageSummary コレクション オブジェクトを返します。

次の例は、この API を呼び出す方法を示しています。

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/beta/reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。 すべてのプロパティは、実際の呼び出しから返されます。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context":"https://graph.microsoft.com/beta/reports/$metadata#Collection(microsoft.graph.getCredentialUsageSummary)",
  "value":[
    {
      "id" : "id-value",
      "feature":"registration",
      "successfulActivityCount":12345,
      "failureActivityCount": 123,
      "authMethod": "email"
    }
  ]
}