onEmailOtpSendListener 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 the applications that listen to the onEmailOtpSend event, the corresponding custom extension handler ID, and the request timeout length.

Inherits from authenticationEventListener.

For more information, see Configure a custom email provider for one time passcode send events (preview).

Methods

None.

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

Properties

Property	Type	Description
authenticationEventsFlowId	String	The identifier of the authenticationEventsFlow object. Inherited from authenticationEventListener.
conditions	authenticationConditions	The conditions on which this authenticationEventListener should trigger. Inherited from authenticationEventListener.
handler	onOtpSendHandler	Used to configure what to invoke if the onEmailOTPSend event resolves to this listener. This base class serves as a generic OTP event handler used for both email and SMS OTP messages.
id	String	The unique identifier for the onEmailOtpSendCustomExtension object. Inherited from entity.
displayName	String	The display name of the listener. Inherited from authenticationEventListener.
priority	Int32	The priority of this handler. Between 0 (lower priority) and 1000 (higher priority). Inherited from authenticationEventListener.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

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