phoneAuthenticationMethod を更新

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

電話の認証方法に関連付けられている電話番号を更新します。

電話の種類は変更できません。 電話機の種類を変更するには、目的の種類の新しい番号を追加してから、元の種類のオブジェクトを削除します。

ユーザーが SMS を使用してサインインするようにポリシーによって有効になっている場合、 mobile 番号が変更されると、システムはそのシステムで使用するために番号を登録しようとします。

セルフサービス操作はサポートされていません。

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

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

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) UserAuthMethod-Phone.ReadWrite UserAuthenticationMethod.ReadWrite.All、UserAuthMethod-Phone.ReadWrite.All、UserAuthenticationMethod.ReadWrite
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション UserAuthenticationMethod.ReadWrite.All UserAuthMethod-Phone.ReadWrite.All

重要

サインイン ユーザーが別のユーザーを操作している職場または学校アカウントを使用してアクセスを委任するには、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 この操作では、必要最小限の特権のみを提供する次の組み込みロールがサポートされます。

  • 認証管理者
  • 特権認証管理者

ユーザーが独自の認証方法を管理すると、ユーザーが最後の認証を行ってから現在のセッションで 10 分以上経った場合、システムは多要素認証 (MFA) を完了するように求めます。

HTTP 要求

別のユーザーの電話認証方法を更新する。 ユーザーは自分の電話認証方法を更新できません。

PATCH /users/{id | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}

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

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-type application/json. 必須です。

要求本文

要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれていない既存のプロパティは、他のプロパティ値の変更に基づいて再計算されます。

プロパティ 説明
phoneNumber String 携帯ショートメール(SMS) または認証通話用の電話番号。 電話番号の形式は "+<国コード><番号>x<内線番号>" で、内線番号はオプションです。 たとえば、+1 5555551234または +1 5555551234x123 が有効です。 必要な形式と一致しない場合、数値は作成/更新時に拒否されます。
phoneType string 指定できる値は、 mobilealternateMobile、または office です。

応答

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

要求

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

PATCH https://graph.microsoft.com/beta/users/kim@contoso.com/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7
Content-type: application/json

{
  "phoneNumber": "+1 2065555554",
  "phoneType": "mobile",
}

応答

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

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

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

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