Update smsAuthenticationMethodConfiguration

Namespace: microsoft.graph

Update the properties of a smsAuthenticationMethodConfiguration object, which represents the SMS authentication method policy for the Azure AD tenant.

This API is supported in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Policy.ReadWrite.AuthenticationMethod
Delegated (personal Microsoft account) Not supported.
Application Policy.ReadWrite.AuthenticationMethod

For delegated scenarios, the administrator needs at least the Authentication Policy Administrator Azure AD role.

HTTP request

PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

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

The following table specifies the properties that can be updated.

Property Type Description
excludeTargets excludeTarget collection Groups of users that are excluded from the policy.
state authenticationMethodState Possible values are: enabled, disabled.

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


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



Here's an example of a request.

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

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


Here's an example of the response

HTTP/1.1 204 No Content