Skip to content

onotpsendcustomextension.md

Latest commit

 

History

History
73 lines (61 loc) · 3.71 KB

onotpsendcustomextension.md

File metadata and controls

73 lines (61 loc) · 3.71 KB
title onOtpSendCustomExtension resource type
description Used for creating a new custom extension based on the onEmailOtpSend event.
author AlexanderMars
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type resourcePageType
ms.date 07/28/2025
toc.title On OTP send custom extension

onOtpSendCustomExtension resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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) or Try out this event in the Woodgrove demo tenant.

Methods

None.

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

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.
id String The unique identifier for the onEmailOtpSendCustomExtension object. Inherited from entity.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.onOtpSendCustomExtension",
  "id": "String (identifier)",
  "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"
  }
}