Edit

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

Used for configuring what authentication methods are enabled for the authentication flow as defined in the onAuthenticationMethodLoadStart event in an externalUsersSelfServiceSignUpEventsFlow user flow type. If this listener isn't specified, the default option is email one time passcode (OTP).

Inherits from authenticationEventListener.

Methods

Method Return type Description
List authenticationEventListeners authenticationEventListener collection Retrieve a list of the following object types derived from authenticationEventListener:
  • onTokenIssuanceStartListener
  • onInteractiveAuthFlowStartListener
  • onAuthenticationMethodLoadStartListener
  • onAttributeCollectionListener
  • onUserCreateStartListener
  • onAttributeCollectionStartListener
  • onAttributeCollectionSubmitListener
    		•
    Create authenticationEventListener authenticationEventListener Create a new onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener:
  • onTokenIssuanceStartListener
  • onInteractiveAuthFlowStartListener
  • onAuthenticationMethodLoadStartListener
  • onAttributeCollectionListener
  • onUserCreateStartListener
  • onAttributeCollectionStartListener
  • onAttributeCollectionSubmitListener
    		•
    Get authenticationEventListener authenticationEventListener Read the properties and relationships of an onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener:
  • onTokenIssuanceStartListener
  • onInteractiveAuthFlowStartListener
  • onAuthenticationMethodLoadStartListener
  • onAttributeCollectionListener
  • onUserCreateStartListener
  • onAttributeCollectionStartListener
  • onAttributeCollectionSubmitListener
    		•
    Update authenticationEventListener None Update the properties of an onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener:
  • onTokenIssuanceStartListener
  • onInteractiveAuthFlowStartListener
  • onAuthenticationMethodLoadStartListener
  • onAttributeCollectionListener
  • onUserCreateStartListener
  • onAttributeCollectionStartListener
  • onAttributeCollectionSubmitListener
    		•
    Delete authenticationEventListener None Delete an onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener:
  • onTokenIssuanceStartListener
  • onInteractiveAuthFlowStartListener
  • onAuthenticationMethodLoadStartListener
  • onAttributeCollectionListener
  • onUserCreateStartListener
  • onAttributeCollectionStartListener
  • onAttributeCollectionSubmitListener
    		•

    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.
    handler onAuthenticationMethodLoadStartHandler Required. Configuration for what to invoke if the event resolves to this listener. This lets us define potential handler configurations per-event.

    Relationships

    None.

    JSON representation

    The following JSON representation shows the resource type.

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