Edit

Share via

identityUserFlow resource type

  • Article

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.

User Flows enable you to define predefined, configurable policies for sign-in, sign-up, combined sign-up and sign-in, password reset, and profile update.

Methods

Method Return Type Description
List UserFlow collection List UserFlows.
Create UserFlow Create UserFlow object.
Get UserFlow Read properties and relationships of UserFlow object.
Delete None Delete UserFlow object.

Properties

Property Type Description
id String The identifier of the user flow. The prefix of B2C_1_ is added to the value that you provide.
userFlowType userFlowType Possible values are: signUp, signIn, signUpOrSignIn, passwordReset, profileUpdate, resourceOwner, unknownFutureValue.
userFlowTypeVersion Single The version number of the user flow type. Each user flow type can have different possible versions such as 1, 1.1 or 2.

Relationships

None

JSON representation

The following JSON representation shows the resource type.

{
  "id": "String (identifier)",
  "userFlowType": "string",
  "userFlowTypeVersion": "Single"
}