title	Update smsAuthenticationMethodConfiguration
description	Update the properties of an smsAuthenticationMethodConfiguration object.
author	luc-msft
ms.reviewer	intelligentaccesspm
ms.localizationpriority	medium
ms.subservice	entra-sign-in
doc_type	apiPageType
ms.date	04/04/2024

Update smsAuthenticationMethodConfiguration

Namespace: microsoft.graph

Update the properties of a smsAuthenticationMethodConfiguration object, which represents the SMS 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/sms

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
excludeTargets	excludeTarget collection	Groups of users that are excluded from the policy.
state	authenticationMethodState	The possible values are: `enabled`, `disabled`.

Note: The @odata.type property with a value of #microsoft.graph.smsAuthenticationMethodConfiguration must be included in the body.

Response

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

Examples

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration",
    "id": "Sms",
    "state": "enabled"
}