b2xIdentityUserFlow resource type

Namespace: microsoft.graph

Represents a self-service sign up user flow within a Microsoft Entra tenant.

User flows are used to enable a self-service sign up experience for guest users on an application. User flows define the experience the end user sees while signing up, including which identity providers they can use to authenticate, along with which attributes are collected as part of the sign up process.

Inherits from base class identityUserFlow.

Methods

Method	Return Type	Description
List user flows	b2xIdentityUserFlow collection	Retrieve all self-service sign-up user flows.
Get user flow	b2xIdentityUserFlow	Retrieve properties of a self-service sign-up user flow.
Create user flow	b2xIdentityUserFlow	Create a new self-service sign-up user flow.
Delete user flow	None	Delete a self-service sign-up user flow.
List identity providers	identityProvider collection	Retrieve all identity providers in a self-service sign-up user flow.
Add identity provider	None	Add an identity provider to a self-service sign-up user flow.
Remove identity provider	None	Remove an identity provider from a self-service sign-up user flow.
List user attribute assignments	identityUserFlowAttributeAssignment collection	Retrieve all user attribute assignments in a self-service sign-up user flow.
Create user attribute assignment	identityUserFlowAttributeAssignment	Create a user attribute assignment in a self-service sign-up user flow.
List languages	userFlowLanguageConfiguration collection	Retrieve all languages within a self-service sign-up user flow.
Get API connectors configuration for user flow	userFlowApiConnectorConfiguration	Get the configuration for API connectors used in the self-service sign-up user flow. The $expand query parameter isn't supported for this method.
Configure an API connector in a user flow	None	Configure an API connector for specific steps in a self-service sign-up user flow by updating the apiConnectorConfiguration property.

Properties

Property	Type	Description
apiConnectorConfiguration	userFlowApiConnectorConfiguration	Configuration for enabling an API connector for use as part of the self-service sign-up user flow. You can only obtain the value of this object using Get userFlowApiConnectorConfiguration.
id	String	The name of the user flow is a required value and is immutable after it's created. The name will be prefixed with the value of B2X_1_ after creation.
userFlowType	userFlowType	The type of user flow. For self-service sign-up user flows, the value can only be signUpOrSignIn and can't be modified after creation.
userFlowTypeVersion	Single	The version of the user flow. For self-service sign-up user flows, the version is always 1.

Relationships

Relationship	Type	Description
identityProviders	identityProvider collection	The identity providers included in the user flow.
languages	userFlowLanguageConfiguration collection	The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows.
userAttributeAssignments	identityUserFlowAttributeAssignment collection	The user attribute assignments included in the user flow.

JSON representation

The following JSON representation shows the resource type.

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