List phoneMethods
Namespace: microsoft.graph
Retrieve a list of phone authentication method objects for a user. This will return up to three objects, as a user can have up to three phones usable for authentication. This method is available only for standard Azure AD and B2B users, but not B2C users.
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 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
List your own phone authentication methods.
GET /me/authentication/phoneMethods
List your own or another user's phone authentication methods.
GET /users/{id | userPrincipalName}/authentication/phoneMethods
Optional query parameters
This method does not support optional query parameters to customize the response.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token} |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of phoneAuthenticationMethod objects in the response body.
Examples
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/me/authentication/phoneMethods
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
{
"value": [
{
"phoneNumber": "+1 2065555555",
"phoneType": "mobile",
"smsSignInState": "ready",
"id": "3179e48a-750b-4051-897c-87b9720928f7"
},
{
"phoneNumber": "+1 2065555556",
"phoneType": "alternateMobile",
"smsSignInState": "notSupported",
"id": "b6332ec1-7057-4abe-9331-3d72feddfe41"
},
{
"phoneNumber": "+1 2065555557",
"phoneType": "office",
"smsSignInState": "notSupported",
"id": "e37fc753-ff3b-4958-9484-eaa9425c82bc"
}
]
}
Feedback
Submit and view feedback for