phoneAuthenticationMethod リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

ユーザーに登録されている電話番号と種類、ユーザーが SMS 経由でサインインするように構成されているかどうかを表します。

電話には、モバイル、代替モバイル、またはオフィスの 3 種類のいずれかがあります。 ユーザーは、種類ごとに 1 つの番号を登録でき、代替の携帯電話を追加する前に携帯電話を持っている必要があります。 多要素認証 (MFA) またはセルフサービス パスワード リセット (SSPR) に電話を使用する場合、携帯電話が既定で、代替携帯電話がバックアップになります。

プライマリ携帯電話は、テナントの設定に応じて、SMS と音声通話の両方に使用できます。

オフィス電話では、SMS メッセージではなく音声通話のみを受信できます。

これは、authenticationMethod リソースの種類から継承する派生型です。

メソッド

メソッド 戻り値の型 説明
List phoneAuthenticationMethod このユーザーのすべての phoneAuthenticationMethod オブジェクトのプロパティとリレーションシップを読み取ります。
Get phoneAuthenticationMethod ユーザーの phoneAuthenticationMethod オブジェクトのプロパティとリレーションシップを読み取ります。
追加する phoneAuthenticationMethod ユーザーの phoneAuthenticationMethod オブジェクトを作成します。
Update なし ユーザーの phoneAuthenticationMethod オブジェクトを更新します。
Delete なし ユーザーの phoneAuthenticationMethod オブジェクトを削除します。
SMS サインインを無効にする なし ユーザーの SMS サインインを無効にします。
SMS サインインを有効にする なし ユーザーの SMS サインインを有効にします。

プロパティ

プロパティ 種類 説明
id String このユーザーに登録されているこの電話の識別子。 読み取り専用です。

ID の値は、次のいずれかです。
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - phoneType が alternateMobile である場合。
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - phoneType が office である場合。
  • 3179e48a-750b-4051-897c-87b9720928f7 - phoneType が mobile である場合。
phoneNumber String 携帯ショートメール（SMS） または認証通話用の電話番号。 電話番号は +{country code} {number}x{extension} 形式を使用し、内線は省略可能です。 たとえば、+1 5555551234 または +1 5555551234x123 は有効です。 番号が必要な形式と一致しない場合、作成または更新時に拒否されます。
phoneType authenticationPhoneType この電話の種類。 使用可能な値は、mobile、alternateMobile、office です。
smsSignInState authenticationMethodSignInState SMS サインインに電話を使用する準備ができているかどうか。 可能な値は、notSupported、notAllowedByPolicy、notEnabled、phoneNumberNotUnique、ready、notConfigured、unknownFutureValue です。

authenticationPhoneType の値

電話には 3 つの種類を指定できます。使用可能な値は次のとおりです。

値 説明
モバイル SMS や音声通話に使用できるプライマリ携帯電話。
alternateMobile 音声通話にのみ使用できる代替またはバックアップの携帯電話。
オフィス 音声通話にのみ使用できるオフィス電話または固定電話。

authenticationMethodSignInState の値

SMS サインイン状態プロパティは、電話番号が SMS 経由でサインインする準備ができているかどうかに関する情報を提供します。 使用可能な値は次のとおりです。

値 説明
notSupported この認証方法では、プライマリ サインインはサポートされていません。 たとえば、サインインはユーザーのプライマリ モバイル番号でのみ有効にできますが、代替番号では有効にできません。
notAllowedByPolicy このユーザーは、このメソッドをプライマリ サインインとして使用するようにポリシーによって有効になっていません。
notConfigured このユーザーは、このメソッドをプライマリ サインインとして使用するようにポリシーによって有効になっていますが、構成するにはさらにアクションを実行する必要があります。
phoneNumberNotUnique このユーザーは、プライマリ サインインとして電話番号を設定しようとしましたが、その番号は一意ではなく、サインイン名として使用できません。
準備完了 この認証方法は、プライマリ サインインで使用する準備ができています。
notEnabled このサインイン メソッドが有効になっていません

リレーションシップ

なし。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "id": "String (identifier)",
  "phoneNumber": "String",
  "phoneType": "string",
  "smsSignInState": "string"
}