reportRoot: getCredentialUsageSummaryreportRoot: getCredentialUsageSummary

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

組織内のユーザーの数について、セルフサービスのパスワードのリセット機能を使用した現在の状態を報告します。Report the current state of how many users in your organization used the self-service password reset capabilities.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校アカウント)Delegated (work or school account) Reports.Read.AllReports.Read.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Reports.Read.AllReports.Read.All

HTTP 要求HTTP request

GET /reports/getCredentialUsageSummary

関数パラメーターFunction parameters

次の関数パラメーターを使用して、応答を調整できます。You can use the following function parameter to adjust the response.

パラメーターParameter Type 説明Description
periodperiod StringString 利用状況データを必要とする期間を指定します。Specifies the time period for which you need the usage data. 例: /reports/getCredentialUsageSummary(period='D30')For example: /reports/getCredentialUsageSummary(period='D30'). サポートされD1D7いる期間D30:、、。Supported periods: D1, D7, and D30. ピリオドは大文字と小文字を区別しません。Period is case insensitive.

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

この関数は、オプションの OData クエリパラメーター $filterをサポートします。This function supports the optional OData query parameter $filter. CredentialUsageSummaryリソースの次の1つ以上のプロパティに $filterを適用できます。You can apply $filter on one or more of the following properties of the credentialUsageSummary resource.

プロパティProperties 説明と例Description and example
特徴feature 必要な利用状況データの種類 (登録とリセット) を指定します。Specifies the type of usage data you want (registration vs. reset). 例: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'For example: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'. サポートされてeqいるフィルター演算子:。Supported filter operators: eq.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}Bearer {token}
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッド200 OKは応答コードと、応答本文で新しいcredentialUsageSummary collection オブジェクトを返します。If successful, this method returns a 200 OK response code and a new credentialUsageSummary collection object in the response body.

Examples

次の例は、この API を呼び出す方法を示しています。The following example shows how to call this API.

要求Request

要求の例を次に示します。The following is an example of the request.

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

応答Response

応答の例を次に示します。The following is an example of the response.

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。Note: The response object shown here might be shortened for readability. すべてのプロパティは、実際の呼び出しから返されます。All the properties are returned from an actual call.

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"
    }
  ]
}