Create userFlow

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.


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.

Create a new userFlow object.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) IdentityUserFlow.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application IdentityUserFlow.ReadWrite.All

HTTP request

POST /identity/userFlows

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-type application/json. Required.

Request body

In the request body, supply a JSON representation of userFlow object.


If successful, this method returns a 201 Created response code and a new userFlow object in the response body.



The following is an example of the request.

Content-type: application/json

  "id": "Pol1",
  "userFlowType": "signUpOrSignIn",
  "userFlowTypeVersion": 1


The following is an example of the response.

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

HTTP/1.1 201 Created
Content-type: application/json

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