userCredentialUsageDetails を一覧表示する
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
特定のテナントの userCredentialUsageDetails オブジェクトの 一覧を取得します。 詳細には、ユーザー情報、リセットの状態、失敗の理由が含まれます。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Reports.Read.All | 注意事項なし。 |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | Reports.Read.All | 注意事項なし。 |
重要
職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーは、グループの所有者またはメンバーであるか、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールが割り当てられている必要があります。 この操作では、次の最小特権ロールがサポートされています。
- レポート閲覧者
- セキュリティ閲覧者
- セキュリティ管理者
- グローバル閲覧者
HTTP 要求
GET /reports/userCredentialUsageDetails
オプションのクエリ パラメーター
この関数は、省略可能な OData クエリ パラメーター $filterをサポートします。 userCredentialUsageDetails リソースの次のプロパティの 1 つ以上に$filterを適用できます。
プロパティ | 説明と例 |
---|---|
特徴 | 必要な使用状況データの種類でフィルター処理します (登録とリセット)。 例: /reports/userCredentialUsageDetails?$filter=feature eq 'registration' 。 サポートされているフィルター演算子: eq |
userDisplayName | ユーザーの表示名でフィルター処理します。 例: /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso' 。 サポートされているフィルター演算子: eq と startswith() 。 大文字と小文字を区別しないサポート。 |
userPrincipalName | ユーザー プリンシパル名でフィルター処理します。 例: /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso' 。 サポートされているフィルター演算子: eq と startswith() 。 大文字と小文字を区別しないサポート。 |
isSuccess | アクティビティの状態でフィルター処理します。 例: /reports/userCredentialUsageDetails?$filter=isSuccess eq true 。 サポートされているフィルター演算子: eq と orderby 。 |
authMethod | 登録時に を使用して認証方法でフィルター処理します。 例: /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email' 。 サポートされているフィルター演算子: eq 。 |
failureReason | 失敗の理由でフィルター処理します (アクティビティが失敗した場合)。 例: /reports/userCredentialUsageDetails?$filter=failureReason eq 'Contoso' 。 サポートされているフィルター演算子: eq と startswith() 。 大文字と小文字を区別しないサポート。 |
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
Content-Type | application/json |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文の userCredentialUsageDetails オブジェクトのコレクションを返します。
例
次の例は、この API を呼び出す方法を示しています。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/userCredentialUsageDetails
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。 すべてのプロパティは、実際の呼び出しから返されます。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/reports/$metadata#Collection(microsoft.graph.getUserCredentialUsageDetails)",
"value":[
{
"id" : "id-value",
"feature":"registration",
"userPrincipalName":"userPrincipalName-value",
"userDisplayName": "userDisplayName-value",
"isSuccess" : true,
"authMethod": "email",
"failureReason": "User contacted an admin after trying the email verification option",
"eventDateTime" : "2019-04-01T00:00:00Z"
}
]
}