Skip to content

authenticationmethodsroot-list-userregistrationdetails.md

Latest commit

 

History

History
202 lines (166 loc) · 9.03 KB

authenticationmethodsroot-list-userregistrationdetails.md

File metadata and controls

202 lines (166 loc) · 9.03 KB
title List userRegistrationDetails
description Get a list of the authentication methods registered for a user as defined in the userRegistrationDetails object.
author egreenberg14
ms.localizationpriority medium
ms.subservice entra-monitoring-health
doc_type apiPageType
ms.date 07/26/2024

List userRegistrationDetails

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of the authentication methods registered for a user as defined in the userRegistrationDetails object. This method doesn't work for disabled users.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-reports-registration-usage-apis]

HTTP request

GET /reports/authenticationMethods/userRegistrationDetails

Optional query parameters

This method supports the $filter OData query parameter to help customize the response. You can apply $filter on one or more of the following properties of the userRegistrationDetails resource.

Property Description Example
isMfaCapable Filter for users who are ready to perform password reset or multi-factor authentication (MFA). Supported filter operators: eq. /reports/authenticationMethods/userRegistrationDetails?$filter=isMfaCapable eq true
isMfaRegistered Filter for users who are registered for MFA. Supported filter operators are: eq. /reports/authenticationMethods/userRegistrationDetails?$filter=isMfaRegistered eq true
isSsprEnabled Filter for users who have been enabled for SSPR. Supported filter operators are: eq. /reports/authenticationMethods/userRegistrationDetails?$filter=isSsprEnabled eq true.
isSsprRegistered Filter for users who have registered for self-service password reset (SSPR). Supported filter operators are: eq. /reports/authenticationMethods/userRegistrationDetails?$filter=isSsprRegistered eq true
methodsRegistered Filter by the authentication methods used during registration. Supported filter operators are: eq. /reports/authenticationMethods/userRegistrationDetails?$filter=methodsRegistered/any(x:x eq 'email')
userDisplayName Filter by user name. Supported filter operators are: eq and startswith(). Supports case insensitive. /reports/authenticationMethods/userRegistrationDetails?$filter=userDisplayName eq 'Contoso'
userPrincipalName Filter by user principal name. Supported filter operators are: eq and startswith(). Supports case insensitive. /reports/authenticationMethods/userRegistrationDetails?$filter=userPrincipalName eq 'Contoso'

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of userRegistrationDetails objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/reports/authenticationMethods/userRegistrationDetails

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/authenticationMethods/userRegistrationDetails",
  "value": [
    {
      "id": "86462606-fde0-4fc4-9e0c-a20eb73e54c6",
      "userPrincipalName": "AlexW@Contoso.com",
      "userDisplayName": "Alex Wilber",
      "isAdmin": false,
      "isSsprRegistered": false,
      "isSsprEnabled": false,
      "isSsprCapable": false,
      "isMfaRegistered": true,
      "isMfaCapable": true,
      "isPasswordlessCapable": false,
      "lastUpdatedDateTime": "2023-03-13T19:15:41.6195833Z",
      "methodsRegistered": [
        "microsoftAuthenticatorPush",
        "softwareOneTimePasscode"
      ],
      "defaultMfaMethod": "microsoftAuthenticatorPush",
      "isSystemPreferredAuthenticationMethodEnabled": true,
      "systemPreferredAuthenticationMethods": [                
        "push"
      ],
      "userPreferredMethodForSecondaryAuthentication": "push",       
      "userType": "member"
    },
    {
      "id": "c6ad1942-4afa-47f8-8d48-afb5d8d69d2f",
      "userPrincipalName": "AllanD@Contoso.com",
      "userDisplayName": "Allan Deyoung",
      "isAdmin": false,
      "isSsprRegistered": false,
      "isSsprEnabled": false,
      "isSsprCapable": false,
      "isMfaRegistered": false,
      "isMfaCapable": false,
      "isPasswordlessCapable": false,
      "lastUpdatedDateTime": "2023-03-13T19:15:41.6195833Z",
      "methodsRegistered": [],
      "defaultMfaMethod": "",
      "isSystemPreferredAuthenticationMethodEnabled": true,
      "systemPreferredAuthenticationMethods": [],
      "userPreferredMethodForSecondaryAuthentication": "",      
      "userType": "guest"
    },
    {
      "id": "c8096958-797c-44fa-8fde-a6fb62567cf0",
      "userPrincipalName": "BiancaP@Contoso.com",
      "userDisplayName": "Bianca Pisani",
      "isAdmin": false,
      "isSsprRegistered": true,
      "isSsprEnabled": false,
      "isSsprCapable": false,
      "isMfaRegistered": true,
      "isMfaCapable": true,
      "isPasswordlessCapable": false,
      "lastUpdatedDateTime": "2023-03-13T19:15:41.6195833Z",
      "methodsRegistered": [
        "mobilePhone",
        "microsoftAuthenticatorPush",
        "softwareOneTimePasscode"
      ],
      "defaultMfaMethod": "mobilePhone",
      "isSystemPreferredAuthenticationMethodEnabled": true,
      "systemPreferredAuthenticationMethods": [                
        "push"
      ],
      "userPreferredMethodForSecondaryAuthentication": "voiceMobile",      
      "userType": "member"
    }
  ]
}