Get b2cIdentityUserFlow

Namespace: microsoft.graph


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.

Retrieve the properties and relationships of a b2cUserFlow object.

This API is available in the following national cloud deployments.

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


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) IdentityUserFlow.Read.All IdentityUserFlow.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application IdentityUserFlow.Read.All IdentityUserFlow.ReadWrite.All

The work or school account needs to belong to at least the External ID User Flow Administrator Microsoft Entra role.

HTTP request

GET /identity/b2cUserFlows/{id}

Optional query parameters

You can use $expand to expand specific user flow properties that are not expanded by default.

For more information, see OData query parameters.

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.


If successful, this method returns a 200 OK response code and a b2cIdentityUserFlow object in the response body.



The following example shows a request.



The following example shows the response.

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

    "id": "B2C_1_CustomerSignUp",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "isLanguageCustomizationEnabled": false,
    "defaultLanguageTag": null