List credentialUserRegistrationDetails

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Important

The credential user registration details API is deprecated and will stop returning data on June 30, 2024. Use the User registration details API instead.

Get a list of credentialUserRegistrationDetails objects for a given tenant.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Reports.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Reports.Read.All Not available.

For delegated scenarios, the calling user must have at least one of the following Microsoft Entra roles:

  • Reports Reader
  • Security Reader
  • Security Administrator
  • Global Reader

HTTP request

GET /reports/credentialUserRegistrationDetails

Optional query parameters

This function supports the optional OData query parameter $filter. You can apply $filter on one or more of the following properties of the credentialUserRegistrationDetails resource.

Properties Description and example
userDisplayName Filter by user name. For example: /reports/credentialUserRegistrationDetails?$filter=userDisplayName eq 'Contoso'. Supported filter operators: eq, and startswith(). Supports case insensitive.
userPrincipalName Filter by user principal name. For example: /reports/credentialUserRegistrationDetails?$filter=userPrincipalName eq 'Contoso'. Supported filter operators: eq and startswith(). Supports case insensitive.
authMethods Filter by the authentication methods used during registration. For example: /reports/credentialUserRegistrationDetails?$filter=authMethods/any(t:t eq microsoft.graph.registrationAuthMethod'email'). Supported filter operators: eq.
isRegistered Filter for users who have registered for self-service password reset (SSPR). For example: /reports/credentialUserRegistrationDetails?$filter=isRegistered eq true. Supported filter operators: eq.
isEnabled Filter for users who have been enabled for SSPR. For example: /reports/credentialUserRegistrationDetails?$filter=isEnabled eq true. Supported filtter operators: eq.
isCapable Filter for users who are ready to perform password reset or multi-factor authentication (MFA). For example: /reports/credentialUserRegistrationDetails?$filter=isCapable eq true. Supported filter operators: eq
isMfaRegistered Filter for users who are registered for MFA. For example: /reports/credentialUserRegistrationDetails?$filter=isMfaRegistered eq true. Supported filter operators: eq.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json

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 credentialUserRegistrationDetails objects in the response body.

Examples

The following example shows how to call this API.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/credentialUserRegistrationDetails

Response

The following example shows 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.credentialUserRegistrationDetails)",
  "value":[
    {
      "id" : "id-value",
      "userPrincipalName":"userPrincipalName",
      "userDisplayName": "userDisplayName-value",
      "authMethods": ["email", "mobileSMS"],
      "isRegistered" : false,
      "isEnabled" : true,
      "isCapable" : false,
      "isMfaRegistered" : true
    }
  ]
}