Disable SMS sign-in for an existing mobile phone number registered to a user. The number will no longer be available for SMS sign-in, which can prevent your user from signing in.
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permissions acting on self
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
UserAuthenticationMethod.ReadWrite
Delegated (personal Microsoft account)
Not supported.
Application
Not supported.
Permissions acting on other users
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
UserAuthenticationMethod.ReadWrite.All
Delegated (personal Microsoft account)
Not supported.
Application
UserAuthenticationMethod.ReadWrite.All
For delegated scenarios where an admin is acting on another user, the administrator needs at least the Authentication Administrator or Privileged Authentication AdministratorMicrosoft Entra role.
HTTP request
Disable SMS sign-in for your own mobile phone authentication method.
POST /me/authentication/phoneMethods/{mobilePhoneMethodId}/disableSmsSignIn
Disable SMS sign-in for your own or another user's mobile phone authentication method.
POST /users/{id | userPrincipalName}/authentication/phoneMethods/{mobilePhoneMethodId}/disableSmsSignIn
The value of mobilePhoneMethodId for the mobile phoneType is 3179e48a-750b-4051-897c-87b9720928f7.
POST https://graph.microsoft.com/v1.0/me/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7/disableSmsSignIn
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Authentication.PhoneMethods["{phoneAuthenticationMethod-id}"].DisableSmsSignIn.PostAsync();
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Authentication().PhoneMethods().ByPhoneAuthenticationMethodId("phoneAuthenticationMethod-id").DisableSmsSignIn().Post(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
graphClient.me().authentication().phoneMethods().byPhoneAuthenticationMethodId("{phoneAuthenticationMethod-id}").disableSmsSignIn().post();
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$graphServiceClient->me()->authentication()->phoneMethods()->byPhoneAuthenticationMethodId('phoneAuthenticationMethod-id')->disableSmsSignIn()->post()->wait();
Import-Module Microsoft.Graph.Users.Actions
# A UPN can also be used as -UserId.
Disable-MgUserAuthenticationPhoneMethodSmsSignIn -UserId $userId -PhoneAuthenticationMethodId $phoneAuthenticationMethodId
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.