Get userFlow

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.

Caution

The user flow API is deprecated and will stop returning data in January 2022. Please use the B2C user flow or Self-service sign up user flow API, depending on your external identity needs.

Retrieve the properties and associations for an userFlow object.

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

HTTP request

GET /identity/userFlows/{id}

Request headers

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

Request body

Don't supply a request body for this method.

Response

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

Examples

Request

Here's an example of the request.

GET https://graph.microsoft.com/beta/identity/userFlows/B2C_1_Pol1

Response

Here's an example of the response.

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

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

{
    "id": "B2C_1_Pol1",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}