Edit

Share via

Update onOtpSendCustomExtension

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

Update the properties of an onOtpSendCustomExtension object.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permission Higher privileged permissions
Delegated (work or school account) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Important

In delegated scenarios with work or school accounts, the admin must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation:

  • Authentication Extensibility Administrator
  • Application Administrator

HTTP request

PUT /identity/authenticationEventListeners/{listenerId}/microsoft.graph.onEmailOtpSendListener/handler/microsoft.graph.onOtpSendCustomExtensionHandler/customExtension/$ref

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

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.

Response

If successful, this method returns a 200 OK response code and an updated onOtpSendCustomExtension object in the response body.

Examples

Request

The following example shows a request.

PUT /identity/authenticationEventListeners/{listenerId}/microsoft.graph.onEmailOtpSendListener/handler/microsoft.graph.onOtpSendCustomExtensionHandler/customExtension/$ref
Content-Type: application/json

{
  "@odata.type": "microsoft.graph.onOtpSendCustomExtension",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.azureAdTokenAuthentication",
    "resourceId": "api://customonemailprovider.azurwebsites.net/f9c5dc6b-d72b-4226-8ccd-801f7a290428"
  },
  "clientConfiguration": {
    "timeoutInMilliseconds": 1000,
    "maximumRetries": 1,
  },
  "description": "Sends OTP Code via ACS.",
  "displayName": "ACS Emails",
  "endpointConfiguration": {
    "@odata.type": "microsoft.graph.httpRequestEndpoint",
 	  "targetUrl": "https://customonemailprovider.azurewebsites.net/api/sendOneTimeCode"
  },
  "behaviorOnError": {
    "@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
  }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "microsoft.graph.onOtpSendCustomExtension",
  "id": "1c8b03b2-7663-fbe9-960a-bc541decd469",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.azureAdTokenAuthentication",
    "resourceId": "api://customonemailprovider.azurwebsites.net/f9c5dc6b-d72b-4226-8ccd-801f7a290428"
  },
  "clientConfiguration": {
    "timeoutInMilliseconds": 1000,
    "maximumRetries": 1,
  },
  "description": "Sends OTP Code via ACS.",
  "displayName": "ACS Emails",
  "endpointConfiguration": {
    "@odata.type": "microsoft.graph.httpRequestEndpoint",
 	  "targetUrl": "https://customonemailprovider.azurewebsites.net/api/sendOneTimeCode"
  },
  "behaviorOnError": {
    "@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
  }
}