Update smsAuthenticationMethodConfiguration

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 a smsAuthenticationMethodConfiguration object, which represents the Text Message authentication method policy for the Azure AD tenant.

Permissions

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 one of the following Azure AD roles:

  • Authentication Policy Administrator
  • Global Administrator

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 a JSON representation of the smsAuthenticationMethodConfiguration object with the values of fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.

The following table shows the properties that are required when you update the smsAuthenticationMethodConfiguration object.

Property Type Description
id String The authentication method policy identifier.
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.

Response

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

Examples

Request

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

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

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.smsAuthenticationMethodConfiguration",
  "id": "713980c7-80c7-7139-c780-3971c7803971",
  "state": "String"
}