Edit

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

Methods

Method Return Type Description
List user flows b2xIdentityUserFlow collection Retrieve all B2X user flows.
Get user flow b2xIdentityUserFlow Retrieve properties of a B2X user flow.
Create user flow b2xIdentityUserFlow Create a new B2X user flow.
Delete user flow None Delete a B2X user flow.
List identity providers identityProvider collection Retrieve all identity providers in a B2X user flow.
Add identity provider None Add an identity provider to a B2X user flow.
Remove identity provider None Remove an identity provider from a B2X user flow.
List identity providers (deprecated) identityProvider collection Retrieve all identity providers in a B2X user flow.
Add identity provider (deprecated) None Add an identity provider to a B2X user flow.
Remove identity provider (deprecated) None Remove an identity provider from a B2X user flow.
List user attribute assignments identityUserFlowAttributeAssignment collection Retrieve all user attribute assignments in a B2X user flow.
Create user attribute assignment identityUserFlowAttributeAssignment Create a user attribute assignment in a B2X user flow.
List languages userFlowLanguageConfiguration collection Retrieve all languages within a B2X 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 isn't 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.

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

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 enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows.

JSON representation

The following JSON representation shows the resource type.

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "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"
    }
}