phoneAuthenticationMethod を取得する

名前空間: microsoft.graph

ユーザーの 1 つの phoneAuthenticationMethod オブジェクトを取得します。 この方法は、標準のMicrosoft Entra IDおよび B2B ユーザーにのみ使用できますが、B2C ユーザーには使用できません。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	❌

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

自己に対して動作するアクセス許可

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	UserAuthenticationMethod.Read、UserAuthenticationMethod.ReadWrite
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	サポートされていません。

他のユーザーに対して動作するアクセス許可

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	UserAuthenticationMethod.Read.All、UserAuthenticationMethod.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	UserAuthenticationMethod.Read.All、UserAuthenticationMethod.ReadWrite.All

管理者が別のユーザーに対して行動している委任されたシナリオの場合、管理者は次のMicrosoft Entraロールの少なくとも 1 つを必要とします。

• グローバル閲覧者
• 認証管理者
• 特権認証管理者

注:

認証管理者には、マスクされた電話番号のみが表示されます。

HTTP 要求

独自の電話認証方法の詳細を取得します。

GET /me/authentication/phoneMethods/{phoneMethodId}

自分または別のユーザーの電話認証方法の詳細を取得します。

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

phoneType に対応する の phoneMethodId 値は、次のいずれかです。

• b6332ec1-7057-4abe-9331-3d72feddfe41を使用して phoneType を取得しますalternateMobile。
• e37fc753-ff3b-4958-9484-eaa9425c82bcを使用して phoneType を取得しますoffice。
• 3179e48a-750b-4051-897c-87b9720928f7を使用して phoneType を取得しますmobile。

オプションのクエリ パラメーター

このメソッドでは、応答をカスタマイズするためのオプションのクエリ パラメーターはサポートされていません。

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で要求された phoneAuthenticationMethod オブジェクトを返します。

例

要求

次の例は要求を示しています。

HTTP

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

C#

// 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
var result = await graphClient.Me.Authentication.PhoneMethods["{phoneAuthenticationMethod-id}"].GetAsync();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users authentication phone-methods get --user-id {user-id} --phone-authentication-method-id {phoneAuthenticationMethod-id}

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



phoneMethods, err := graphClient.Me().Authentication().PhoneMethods().ByPhoneAuthenticationMethodId("phoneAuthenticationMethod-id").Get(context.Background(), nil)

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

PhoneAuthenticationMethod result = graphClient.me().authentication().phoneMethods().byPhoneAuthenticationMethodId("{phoneAuthenticationMethod-id}").get();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let phoneAuthenticationMethod = await client.api('/me/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7')
	.get();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->authentication()->phoneMethods()->byPhoneAuthenticationMethodId('phoneAuthenticationMethod-id')->get()->wait();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PowerShell

Import-Module Microsoft.Graph.Identity.SignIns

# A UPN can also be used as -UserId.
Get-MgUserAuthenticationPhoneMethod -UserId $userId -PhoneAuthenticationMethodId $phoneAuthenticationMethodId

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.me.authentication.phone_methods.by_phone_authentication_method_id('phoneAuthenticationMethod-id').get()

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

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