phone Authenticationmethod resource の種類phoneAuthenticationMethod resource type

名前空間: microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph のバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。Use of these APIs in production applications is not supported. API が v2.0 で利用できるかどうかを確認するには、 バージョン セレクターを使用します。To determine whether an API is available in v1.0, use the Version selector.

ユーザーに登録されている電話機の表現。A representation of a phone registered to a user. このリソースには、電話番号、電話の種類、およびユーザーが SMS 経由でサインインするために電話機が構成されているかどうかが含まれます。This resource includes the phone number, the phone type, and whether the phone is configured for the user to sign in via SMS.

電話には、次の3つの種類があります。モバイル、代替のモバイル、または office。A phone has one of three types: mobile, alternate mobile, or office. ユーザーは、それぞれの種類に対して1つの番号を登録でき、代替の携帯電話が追加される前に携帯電話を持っている必要があります。A user can have one number registered for each type, and must have a mobile phone before an alternate mobile phone is added. 多要素認証 (MFA) またはセルフサービスのパスワードのリセット (SSPR) に電話を使用している場合、携帯電話は既定の設定であり、代替の携帯電話はバックアップです。When using a phone for multi-factor authentication (MFA) or self-service password reset (SSPR), the mobile phone is the default and the alternate mobile phone is the backup.

携帯電話は、テナントの設定に応じて、SMS と音声通話の両方で使用できます。Mobile phones can be used for both SMS and voice calls, depending on the tenant settings.

Office 電話は、SMS メッセージではなく、音声呼び出しのみを受信できます。An office phone can only receive voice calls, not SMS messages.

SMS サインイン状態プロパティは、電話番号が SMS 経由でサインインする準備ができているかどうかについての情報を提供します。The SMS sign-in state property gives information about whether or not a phone number is ready to sign in via SMS. 使用可能な値は次のとおりです。The following are the possible values.

Value 説明Description
notSupported この認証方法では、プライマリサインインはサポートされていません。たとえば、サインインは、代替番号ではなく、ユーザーのプライマリ携帯電話番号に対してのみ有効にすることができます。Primary sign-in not supported on this authentication method - for example, sign-in can be enabled only on a user's primary mobile number, not the alternate number.
notAllowedByPolicy このユーザーは、このメソッドをプライマリサインインとして使用するポリシーによって有効になっていません。This user isn't enabled by policy to use this method as a primary sign-in.
notConfigured このユーザーは、このメソッドをプライマリサインインとして使用するポリシーによって有効になっていますが、構成するには追加の操作を行う必要があります。This user is enabled by policy to use this method as primary sign-in but needs to take additional action to configure it.
phoneNumberNotUnique このユーザーは、電話番号をプライマリサインインとして設定しようとしましたが、番号が一意ではないため、サインイン名として使用できません。This user attempted to set up a phone number as primary sign-in but the number was not unique and can't be used as a sign-in name.
ready この認証方法は、プライマリサインインで使用する準備ができています。This authentication method is ready for use in primary sign-in.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
ListList 電話電話 (Authenticationmethod)phoneAuthenticationMethod このユーザーの電話の Authenticationmethod authenticationmethod オブジェクトすべてのプロパティとリレーションシップを読み取ります。Read properties and relationships of all of this user's phoneAuthenticationMethod objects.
GetGet 電話電話 (Authenticationmethod)phoneAuthenticationMethod Phone Authenticationmethod オブジェクトのプロパティと関係を読み取ります。Read properties and relationships of phoneAuthenticationMethod object.
UpdateUpdate 電話電話 (Authenticationmethod)phoneAuthenticationMethod 電話電話の Authenticationmethod オブジェクトを更新します。Update phoneAuthenticationMethod object.
DeleteDelete なしNone 電話電話の Authenticationmethod オブジェクトを削除します。Delete phoneAuthenticationMethod object.
SMS サインインを無効にするDisable SMS signin なしNone ユーザーの SMS サインインをオフにします。Turn off SMS sign-in for a user.
SMS サインインを有効にするEnable SMS signin なしNone ユーザーに対して SMS サインインを有効にします。Turn on SMS sign-in for a user.

プロパティProperties

プロパティProperty 種類Type 説明Description
idid 文字列String このユーザーに登録されているこの電話の id。The identifier of this phone registered to this user. 読み取り専用です。Read-only.
phoneNumberphoneNumber StringString テキストに対する電話番号または認証のための呼び出し。The phone number to text or call for authentication. 電話番号は、"+ x" という形式を使用し <country code> <number> <extension> ます。拡張子は省略可能です。Phone numbers use the format "+<country code> <number>x<extension>", with extension optional. たとえば、+ 1 5555551234 または + 1 5555551234x123 は有効です。For example, +1 5555551234 or +1 5555551234x123 are valid. 必要な形式と一致しない場合は、番号は作成/更新時に拒否されます。Numbers are rejected when creating/updating if they do not match the required format.
phoneTypephoneType stringstring この電話の種類。The type of this phone. 可能な値は mobile 、、 alternateMobile 、または office です。Possible values are: mobile, alternateMobile, or office.
smsSignInStatesmsSignInState stringstring SMS サインインに電話を使用する準備ができているかどうか。Whether a phone is ready to be used for SMS sign-in or not. 可能な値は、、、、、、 notSupported notAllowedByPolicy notEnabled phoneNumberNotUnique ready または notConfigured です。Possible values are: notSupported, notAllowedByPolicy, notEnabled, phoneNumberNotUnique, ready, or notConfigured.

リレーションシップRelationships

なし。None.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。The following is a JSON representation of the resource.

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