phoneAuthenticationMethod を更新する

名前空間: microsoft.graph

電話認証方法オブジェクトに関連付けられているユーザーの電話番号を更新します。

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

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

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

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

アクセス許可

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

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

サインインしているユーザーが別のユーザーを操作している職場または学校アカウントで委任されたシナリオでは、サポートされている Microsoft Entra ロール またはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。

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

ユーザーは、独自の電話認証方法を更新できません。

HTTP 要求

別のユーザーの電話認証方法を更新します。

PATCH /users/{id | 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}。 必須です。 認証と認可についての詳細をご覧ください。
Content-type application/json. 必須です。

要求本文

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

プロパティ 説明
phoneNumber String 携帯ショートメール(SMS) または認証通話用の電話番号。 電話番号は +{country code} {number}x{extension} 形式を使用し、内線は省略可能です。 たとえば、+1 5555551234 または +1 5555551234x123 は有効です。 数値が必要な形式と一致しない場合、作成または更新時に拒否されます。
phoneType 文字列 使用可能な値は、mobilealternateMobileoffice です。

応答

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

要求

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

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

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

応答

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

HTTP/1.1 204 No Content