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

Used for configuring whether the authentication flow allows for sign-up as defined in the onInteractiveAuthFlowStart event in an externalUsersSelfServiceSignUpEventsFlow user flow type. If this listener isn't specified, then sign up is disabled by default.

Inherits from authenticationEventListener.

Methods

None.

For the list of API operations for managing this resource type, see the authenticationEventListener resource type.

Properties

Property	Type	Description
id	String	Required. Inherited from entity.
conditions	authenticationConditions	Required. Inherited from authenticationEventListener.
priority	Int32	Required. Inherited from authenticationEventListener.
authenticationEventsFlowId	String	Inherited from authenticationEventListener.
displayName	String	The display name of the listener. Inherited from authenticationEventListener.
handler	onInteractiveAuthFlowStartHandler	Required. Configuration for what to invoke if the event resolves to this listener. You can use this handler to define potential handler configurations for specific events.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartListener",
  "id": "String (identifier)",
  "displayName": "String",
  "priority": "Integer",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "authenticationEventsFlowId": "String",
  "handler": {
    "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler"
  }
}