Edit

Share via

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

Read the properties and relationships 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 permissions Higher privileged permissions
Delegated (work or school account) EventListener.Read.All EventListener.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application EventListener.Read.All EventListener.ReadWrite.All

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:

  • Global Reader
  • Authentication Extensibility Administrator
  • Application Administrator

HTTP request

GET /identity/authenticationEventListeners/{listenerId}/microsoft.graph.OnEmailOtpSendListener/handler/microsoft.graph.OnOtpSendCustomExtensionHandler/customExtension

Optional query parameters

This method supports $select and $expand of the OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

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

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/identity/authenticationEventListeners/{listenerId}/microsoft.graph.OnEmailOtpSendListener/handler/microsoft.graph.OnOtpSendCustomExtensionHandler/customExtension

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

{
  "value": {
    "@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"
    }
  }
}