Edit

b2cIdentityUserFlow 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.

Represents a user flow within an Azure Active Directory B2C tenant.

To help you set up the most common identity tasks for your applications, Azure Active Directory B2C includes predefined, configurable policies called user flows. A user flow lets you determine how users interact with your application when they do things like sign in, sign up, edit a profile, or reset a password. You can create many user flows of different types in your tenant and use them in your applications as needed. With user flows, you can control the following capabilities:

  • Account types used for sign-in, such as social accounts like a Facebook or local account
  • Attributes to be collected from the consumer, such as first name, postal code, and shoe size
  • Azure Multi-Factor Authentication
  • Customization of the user interface
  • Information that the application receives in the token

Methods

Method Return Type Description
List user flows b2cIdentityUserFlow collection Retrieve all B2C user flows.
Get user flow b2cIdentityUserFlow Retrieve properties of a B2C user flow.
Create user flow b2cIdentityUserFlow Create a new B2C user flow.
Update user flow b2cIdentityUserFlow Update the properties of a B2C user flow.
Delete user flow None Delete a B2C user flow.
List identity providers identityProvider collection Retrieve all identity providers in a B2C user flow.
Add identity provider None Add an identity provider to a B2C user flow.
Delete identity provider None Remove an identity provider from a B2C user flow
List user attribute assignments identityUserFlowAttributeAssignment collection Retrieve all user attribute assignments in a B2C user flow.
Create user attribute assignment identityUserFlowAttributeAssignment Create a user attribute assignment in a B2C user flow.
List languages userFlowLanguageConfiguration collection Retrieve all languages within a B2C user flow.
Create language userFlowLanguageConfiguration Creates a custom language in a B2C user flow.
Get API connectors configuration for user flow userFlowApiConnectorConfiguration Get the configuration for API connectors used in the user flow. The $expand query parameter is not supported for this method.
Configure an API connector in a user flow None Configure an API connector for specific steps in a user flow by updating the apiConnectorConfiguration property.
List identity providers (deprecated) identityProvider collection Retrieve all identity providers in a B2C user flow.
Add identity provider (deprecated) None Add an identity provider to a B2C user flow.
Delete identity provider (deprecated) None Remove an identity provider from a B2C user flow

Properties

Property Type Description
id String The name of the user flow. This is a required value and is immutable after it's created. The name will be prefixed with the value of B2C_1_ after creation.
userFlowType userFlowType The type of user flow. The supported values for userFlowType are: signUp, signIn, signUpOrSignIn, passwordReset, profileUpdate, resourceOwner.
userFlowTypeVersion Single The version of the user flow.
isLanguageCustomizationEnabled Boolean The property that determines whether language customization is enabled within the B2C user flow. Language customization is not enabled by default for B2C user flows.
defaultLanguageTag String Indicates the default language of the b2cIdentityUserFlow that is used when no ui_locale tag is specified in the request. This field is RFC 5646 compliant.
apiConnectorConfiguration userFlowApiConnectorConfiguration Configuration for enabling an API connector for use as part of the user flow. You can only obtain the value of this object using Get userFlowApiConnectorConfiguration.

Relationships

Relationship Type Description
userflowIdentityProviders identityProviderBase collection The identity providers included in the user flow.
identityProviders (deprecated) identityProvider collection The identity providers included in the user flow.
userAttributeAssignments identityUserFlowAttributeAssignment collection The user attribute assignments included in the user flow.
languages userFlowLanguageConfiguration collection The languages supported for customization within the user flow. Language customization is not enabled by default in B2C user flows.

JSON representation

The following is a JSON representation of the resource.

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "isLanguageCustomizationEnabled": "Boolean",
    "defaultLanguageTag": "String",
    "userflowidentityProviders": [{"@odata.type": "microsoft.graph.identityProviderBase"}],
    "identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}],
    "userAttributeAssignments": [{"@odate.type": "microsoft.graph.identityUserFlowAttributeAssignment"}],
    "languages": [{"@odata.type": "microsoft.graph.userFlowLanguageConfiguration"}],
    "apiConnectorConfiguration": {
      "@odata.type": "microsoft.graph.userFlowApiConnectorConfiguration"
    }
}