名前空間: microsoft.graph
ユーザーの 1 つの phoneAuthenticationMethod オブジェクトを取得します。 この方法は、標準のMicrosoft Entra ID と B2B ユーザーにのみ使用できますが、B2C ユーザーには使用できません。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | UserAuthMethod-Phone.Read | UserAuthenticationMethod.ReadWrite.All、UserAuthenticationMethod.Read、UserAuthenticationMethod.Read.All、UserAuthenticationMethod.ReadWrite、UserAuthMethod-Phone.Read.All、UserAuthMethod-Phone.ReadWrite、UserAuthMethod-Phone.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | UserAuthMethod-Phone.Read.All | UserAuthenticationMethod.ReadWrite.All、UserAuthenticationMethod.Read.All、UserAuthMethod-Phone.ReadWrite.All |
重要
サインインしているユーザーが別のユーザーを操作している職場または学校アカウントで委任されたシナリオでは、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。
- グローバル閲覧者
- 認証管理者
- 特権認証管理者
注:
認証管理者には、マスクされた電話番号のみが表示されます。
HTTP 要求
独自の電話認証方法の詳細を取得します。
注:
/me エンドポイントの呼び出しにはサインインしているユーザーが必要であり、そのため委任されたアクセス許可が必要です。
/me エンドポイントを使用する場合、アプリケーションのアクセス許可はサポートされません。
GET /me/authentication/phoneMethods/{phoneMethodId}
自分または別のユーザーの電話認証方法の詳細を取得します。
注:
サインインしたユーザーを表す{id}を使用して/users/{id} エンドポイントを呼び出す場合、最小特権の委任されたアクセス許可は、読み取り操作の場合は UserAuthenticationMethod.Read、書き込み操作では UserAuthenticationMethod.ReadWrite です。
GET /users/{userId | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}
phoneType に対応する phoneMethodId の値は、次のいずれかです。
-
b6332ec1-7057-4abe-9331-3d72feddfe41を使用して、alternateMobilephoneType を取得します。 -
e37fc753-ff3b-4958-9484-eaa9425c82bcを使用して、officephoneType を取得します。 -
3179e48a-750b-4051-897c-87b9720928f7を使用して、mobilephoneType を取得します。
オプションのクエリ パラメーター
サポートされていません。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文で要求された phoneAuthenticationMethod オブジェクトを返します。
例
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/me/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"phoneNumber": "+1 2065555555",
"phoneType": "mobile",
"smsSignInState": "ready",
"id": "3179e48a-750b-4051-897c-87b9720928f7"
}