phoneAuthenticationMethod リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
ユーザーに登録された電話の表現。 このリソースには、電話番号、電話の種類、ユーザーが SMS 経由でサインインするように電話が構成されているかどうかを示します。
電話には、モバイル、代替モバイル、または Office の 3 つの種類があります。 ユーザーは、種類ごとに 1 つの番号を登録し、代替携帯電話を追加する前に携帯電話を持っている必要があります。 多要素認証 (MFA) またはセルフサービス パスワード リセット (SSPR) に電話を使用する場合、携帯電話が既定で、代替携帯電話がバックアップになります。
携帯電話は、テナントの設定に応じて、SMS 通話と音声通話の両方に使用できます。
オフィス電話は、SMS メッセージではなく音声通話のみを受信できます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | phoneAuthenticationMethod | このユーザーのすべての phoneAuthenticationMethod オブジェクトのプロパティとリレーションシップを読み取る。 |
| Get | phoneAuthenticationMethod | phoneAuthenticationMethod オブジェクトのプロパティとリレーションシップを読み取る。 |
| 更新 | phoneAuthenticationMethod | phoneAuthenticationMethod オブジェクトを更新します。 |
| Delete | なし | phoneAuthenticationMethod オブジェクトを削除します。 |
| SMS サインインを無効にする | なし | ユーザーの SMS サインインをオフにします。 |
| SMS サインインを有効にする | なし | ユーザーの SMS サインインを有効にする。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| id | String | このユーザーに登録されたこの電話の識別子。 読み取り専用。 id の値は、次のいずれかの値です。
|
| phoneNumber | String | テキストまたは認証を呼び出す電話番号。 電話は"+ " という形式を使用します。 <country code> <number>x <extension> ",拡張オプション付き。 たとえば、+1 5555551234または +1 5555551234x123 が有効です。 番号が必要な形式と一致しない場合は、作成および更新時に拒否されます。 |
| phoneType | authenticationPhoneType | この電話の種類。 使用可能な値は、mobile、alternateMobile、office です。 |
| smsSignInState | authenticationMethodSignInState | 電話を SMS サインインに使用する準備ができているかどうか。 使用できる値は notSupported notAllowedByPolicy notEnabled 、、、、、 phoneNumberNotUnique ready notConfigured です unknownFutureValue 。 |
smsSignInState 値
SMS サインイン状態プロパティは、電話番号が SMS 経由でサインインする準備ができているかどうかに関する情報を提供します。 指定できる値は次のとおりです。
| 値 | 説明 |
|---|---|
| notSupported | この認証方法ではプライマリ サインインはサポートされていません。たとえば、サインインは、代替番号ではなく、ユーザーのプライマリ モバイル番号でのみ有効にできます。 |
| notAllowedByPolicy | このユーザーは、このメソッドをプライマリ サインインとして使用するポリシーによって有効になっていません。 |
| notConfigured | このユーザーはポリシーによってこのメソッドをプライマリ サインインとして使用できますが、構成するには追加のアクションを実行する必要があります。 |
| phoneNumberNotUnique | このユーザーは電話番号をプライマリ サインインとして設定しようとしたが、その番号は一意ではなく、サインイン名として使用できない。 |
| ready | この認証方法は、プライマリ サインインで使用できる状態です。 |
| notEnabled | このサインイン メソッドが有効になっていません |
リレーションシップ
なし。
JSON 表記
リソースの JSON 表記を次に示します。
{
"id": "String (identifier)",
"phoneNumber": "String",
"phoneType": "string",
"smsSignInState": "string"
}
フィードバック
フィードバックの送信と表示