Get phoneAuthenticationMethod

Namespace: microsoft.graph

Retrieve a single phoneAuthenticationMethod object for a user. This method is available only for standard Azure AD and B2B users, but not B2C users.

This API is supported in the following national cloud deployments.

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

Permissions

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.Read, 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.Read.All, UserAuthenticationMethod.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All

For delegated scenarios where an admin is acting on another user, the administrator needs at least one of the following Azure AD roles.

  • Global Reader
  • Authentication Administrator
  • Privileged Authentication Administrator

Note

The authentication administrator only sees masked phone numbers.

HTTP request

Retrieve details of your own phone authentication method.

GET /me/authentication/phoneMethods/{phoneMethodId}

Retrieve details of your own or another user's phone authentication method.

GET /users/{userId | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}

The value of phoneMethodId corresponding to the phoneType is one of the following:

  • b6332ec1-7057-4abe-9331-3d72feddfe41 to retrieve the alternateMobile phoneType.
  • e37fc753-ff3b-4958-9484-eaa9425c82bc to retrieve the office phoneType.
  • 3179e48a-750b-4051-897c-87b9720928f7 to retrieve the mobile phoneType.

Optional query parameters

This method does not support optional query parameters to customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and the requested phoneAuthenticationMethod object in the response body.

Examples

Request

The following is an example of the request.

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

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "phoneNumber": "+1 2065555555",
  "phoneType": "mobile",
  "smsSignInState": "ready",
  "id": "3179e48a-750b-4051-897c-87b9720928f7"
}