title	Update emailAuthenticationMethodConfiguration
description	Update the properties of an emailAuthenticationMethodConfiguration object.
author	tilarso
ms.reviewer	intelligentaccesspm
ms.localizationpriority	medium
ms.subservice	entra-sign-in
doc_type	apiPageType
ms.date	07/31/2024

Update emailAuthenticationMethodConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of an emailAuthenticationMethodConfiguration object, which represents the email OTP authentication method policy for the Microsoft Entra tenant.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-policy-apis-write]

HTTP request

PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/email

Request headers

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

Request body

[!INCLUDE table-intro]

Property	Type	Description
allowExternalIdToUseEmailOtp	externalEmailOtpState	Determines whether email OTP is usable by external users for authentication. The possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`.
excludeTargets	excludeTarget collection	Groups of users that are excluded from the policy.
state	authenticationMethodState	Indicates whether this authentication method is enabled or not. The possible values are: `enabled`, `disabled`.

Note: You must include the @odata.type property with a value of #microsoft.graph.emailAuthenticationMethodConfiguration in the request body.

Response

If successful, this method returns a 204 No Content response code. It doesn't return anything in the response body.

Examples

Request

HTTP

PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/email
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
  "allowExternalIdToUseEmailOtp": "disabled",
}