invokeUserFlowListener resource type

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.

You can create an invokeUserFlowListener for the onSignUpStart event. The listener associates an application with a user flow, which enables external identities self-service sign up for the application. Once an application is associated with a user flow, users who go to that application are able to initiate a sign-up flow that provisions a guest account.

Inherits from the abstract base type authenticationListener.

Properties

Property	Type	Description
id	String	The identifier of the action. Inherited from authenticationListener.
priority	Int32	The priority of the action that is used to determine one out of multiple applicable actions. Inherited from authenticationListener.
sourceFilter	authenticationSourceFilter	Filter based on the source of the authentication that is used to determine whether the listener is executed. Inherited from authenticationListener.

Relationships

Relationship	Type	Description
userFlow	b2xIdentityUserFlow	The user flow that is invoked when this action executes.

JSON representation

The following JSON representation shows the resource type.

{
  "id": "String (identifier)",
  "priority": "Integer",
  "sourceFilter": {
    "@odata.type": "microsoft.graph.authenticationSourceFilter"
  },
  "userFlow": {
    "@odata.type": "microsoft.graph.b2xIdentityUserFlow"
  }
}