emailAuthenticationMethodConfiguration リソースの種類

名前空間: microsoft.graph

重要

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

このテナントのメール OTP 認証方法ポリシーを表します。 認証方法ポリシーは、構成設定と、認証方法を使用できるユーザーまたはグループを定義します。 メール OTP は、テナントのクラウドネイティブ ユーザーがセルフサービス パスワードのリセットに使用したり、ユーザー フロー内の特定のアプリに対する招待の引き換えやセルフサービス サインアップ時に外部ユーザーが認証を行う場合に使用できます。

メソッド

メソッド	戻り値の種類	説明
EmailAuthenticationMethodConfiguration を取得する	emailAuthenticationMethodConfiguration	emailAuthenticationMethodConfiguration オブジェクトのプロパティとリレーションシップを読み取る。
emailAuthenticationMethodConfiguration の更新	emailAuthenticationMethodConfiguration	emailAuthenticationMethodConfiguration オブジェクトのプロパティを更新します。
emailAuthenticationMethodConfiguration の削除	なし	emailAuthenticationMethodConfiguration オブジェクトを削除します。

プロパティ

プロパティ	型	説明
id	String	認証方法ポリシー識別子。 authenticationMethodConfiguration から継承されます。
state	authenticationMethodState	この認証方法が有効かどうかを示します。 可能な値は、enabled、disabled です。
allowExternalIdToUseEmailOtp	externalEmailOtpState	外部ユーザーがメール OTP を認証に使用できるかどうかを決定します。 使用可能な値: default、enabled、disabled、unknownFutureValue。 パブリック プレビューを使用しなかった状態のテナントでは default 、2021 年 10 月からメール OTP が自動的に有効になります。

リレーションシップ

リレーションシップ	型	説明
includeTargets	authenticationMethodTarget コレクション	認証方法の使用が有効になっているユーザーまたはグループのコレクション。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
  "id": "String (identifier)",
  "state": "String",
  "allowExternalIdToUseEmailOtp": "String",
  "includeTargets": [ { "@odata.type": "microsoft.graph.authenticationMethodTarget" } ]
}