Skip to content

authentication-list-phonemethods.md

Latest commit

 

History

History
173 lines (127 loc) · 5.79 KB

authentication-list-phonemethods.md

File metadata and controls

173 lines (127 loc) · 5.79 KB
title List phoneMethods
description Retrieve a list of phone authentication method objects for a user.
ms.localizationpriority medium
author luc-msft
ms.reviewer intelligentaccesspm
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 04/04/2024

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 Microsoft Entra ID and B2B users, but not B2C users.

[!INCLUDE national-cloud-support]

Permissions

The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow best practices to request least privileged permissions. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permissions acting on self

[!INCLUDE permissions-table]

Permissions acting on other users

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-apis-read-others]

Note

The authentication administrator only sees masked phone numbers.

HTTP request

List your own phone authentication methods.

GET /me/authentication/phoneMethods

[!INCLUDE me-apis-sign-in-note]

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}. 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 200 OK response code and a collection of phoneAuthenticationMethod objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/me/authentication/phoneMethods

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

CLI

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows 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"
    }
  ]
}