Edit

Share via


phoneAuthenticationMethod: enableSmsSignIn

Namespace: microsoft.graph

Enable SMS sign-in for an existing mobile phone number registered to a user. To be successfully enabled:

  • The phone must have "phoneType": "mobile".
  • The phone must be unique in the SMS sign-in system (no one else can also be using that number).
  • The user must be enabled for SMS sign-in in the authentication methods policy.

This API is available in the following national cloud deployments.

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

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) UserAuthenticationMethod.ReadWrite.All UserAuthenticationMethod.ReadWrite
Delegated (personal Microsoft account) Not supported. Not supported.
Application UserAuthenticationMethod.ReadWrite.All Not available.

Important

In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Authentication Administrator
  • Privileged Authentication Administrator

HTTP request

Enable SMS sign-in for your own mobile phone authentication method.

Note

Calling the /me endpoint requires a signed-in user and therefore a delegated permission. Application permissions aren't supported when using the /me endpoint.

POST /me/authentication/phoneMethods/{id}/enableSmsSignIn

Enable SMS sign-in for your own or another user's mobile phone authentication method.

Note

When calling the /users/{id} endpoint with {id} representing the signed-in user, the least privileged delegated permissions are UserAuthenticationMethod.Read for read operations and UserAuthenticationMethod.ReadWrite for write operations.

POST /users/{id | userPrincipalName}/authentication/phoneMethods/{id}/enableSmsSignIn

The value of id for the mobile phoneType is 3179e48a-750b-4051-897c-87b9720928f7.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

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

Examples

The following example shows how to call this API.

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/me/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7/enableSmsSignIn

Response

The following example shows the response.

HTTP/1.1 204 No Content