Edit

Share via

onOtpSendCustomExtension 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 creating a new custom extension based on the onEmailOtpSend event.

Inherits from customAuthenticationExtension.

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

Methods

Method Return type Description
Get onOtpSendCustomExtension Read the properties and relationships of an onOtpSendCustomExtension object.
Update onOtpSendCustomExtension Update the properties of an onOtpSendCustomExtension object.

Properties

Property Type Description
authenticationConfiguration customExtensionAuthenticationConfiguration The authentication configuration for this custom extension. Inherited from customCalloutExtension. Optional.
behaviorOnError customExtensionBehaviorOnError Let to configure behavior if the call to custom authentication extension returns error. Inherited from customAuthenticationExtension. Optional.
clientConfiguration customExtensionClientConfiguration The connection settings that define how long Microsoft Entra ID can wait for a response from an external app. After this time, Microsoft Entra ID shuts down the connection when trying to trigger the external app. Inherited from customCalloutExtension. Optional.
description String The description for the custom extension. Inherited from customCalloutExtension. Optional.
displayName String The display name for the custom extension. Inherited from customCalloutExtension. Optional.
endpointConfiguration customExtensionEndpointConfiguration The configuration for the API endpoint that the custom extension calls. Inherited from customCalloutExtension. Optional.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.onOtpSendCustomExtension",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
  },
  "clientConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionClientConfiguration"
  },
  "description": "String",
  "displayName": "String",
  "endpointConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
  },
  "behaviorOnError": {
    "@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
  }
}