authenticationEventsFlow リソースの種類

名前空間: microsoft.graph

重要

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

マルチイベント ポリシー ( つまり、ユーザー フロー) を表し、複数のイベントのハンドラー構成を保持します。 name eventType の各プロパティは省略可能であり、イベント リスナーのハンドラー構成に対応します。 このリソースを使用すると、同じ優先順位と条件セットで複数の authenticationEventListener オブジェクトを管理できます。 このリソースは、特定の状況で実行されるイベント リスナーを確認する、より適切に管理されたビューを提供します。

イベントにハンドラーが設定されていない場合、このポリシーはどの認証でもそのイベントに影響せず、そのイベントのリスナーは作成されません。

さらに、このエンティティは、管理するさまざまなイベント リスナーのオーケストレーション ステップとして機能します。 管理するイベント リスナーごとに、それに応じてイベント リスナーを作成、変更、または削除します。 つまり、作成時に、複数のイベント リスナーが作成され、失敗した要求のロールバック シナリオが管理されます。

このリソースは、 externalUsersSelfServiceSignUpEventsFlow オブジェクト型の派生元となる抽象型です。

エンティティ から継承します。

メソッド

メソッド	戻り値の種類	説明
List	authenticationEventsFlow コレクション	authenticationEventsFlow オブジェクトとそのプロパティの一覧を取得します。 externalUserSelfServiceSignupEventsFlow サブタイプのオブジェクトのみが使用できます。
Create	authenticationEventsFlow	新しい authenticationEventsFlow オブジェクトを 作成します。 externalUserSelfServiceSignupEventsFlow サブタイプのオブジェクトのみがサポートされています。
Get	authenticationEventsFlow	authenticationEventsFlow オブジェクトのプロパティとリレーションシップを読み取ります。 externalUserSelfServiceSignupEventsFlow サブタイプのオブジェクトのみが使用できます。
Update	なし	authenticationEventsFlow オブジェクトのプロパティを更新します。 externalUserSelfServiceSignupEventsFlow サブタイプのオブジェクトのみが使用できます。
Delete	なし	authenticationEventsFlow オブジェクトを削除します。 externalUserSelfServiceSignupEventsFlow サブタイプのオブジェクトのみがサポートされています。
ユーザー フロー内の ID プロバイダー
リスト	identityProviderBase コレクション	externalUsersSelfServiceSignupEventsFlow オブジェクトの種類で表される外部 ID セルフサービス サインアップ ユーザー フローに対して定義されている ID プロバイダーを取得します。
追加する	なし	externalUsersSelfServiceSignupEventsFlow オブジェクトの種類で表される外部 ID セルフサービス サインアップ ユーザー フローに ID プロバイダーを追加します。 ID プロバイダーは、まずテナントで構成する必要があります。
Remove	なし	externalUsersSelfServiceSignupEventsFlow オブジェクトの種類で表される外部 ID セルフサービス サインアップ ユーザー フローから ID プロバイダーを削除します。
ユーザー フロー属性
リスト	identityUserFlowAttributes コレクション	すべての組み込みユーザー フロー属性およびカスタム ユーザー フロー属性を取得します。
Create	identityUserFlowAttribute	新しいカスタム ユーザー フロー属性を作成します。
Get	identityUserFlowAttribute	ユーザー フロー属性のプロパティを取得します。
Update	なし	カスタム ユーザー フロー属性を更新します。
Delete	なし	カスタム ユーザー フロー属性を削除します。
ユーザー フロー内の属性を一覧表示する	なし	externalUsersSelfServiceSignupEventsFlow オブジェクトによって表される外部 ID セルフサービス サインアップ ユーザー フローに関連付けられている identityUserFlowAttribute オブジェクトのコレクションを取得します。
ユーザー フローに属性を追加する	なし	externalUsersSelfServiceSignupEventsFlow オブジェクトによって表される外部 ID セルフサービス サインアップ ユーザー フローに関連付けられている identityUserFlowAttribute オブジェクトを追加します。
ユーザー フローから属性を削除する	なし	externalUsersSelfServiceSignupEventsFlow オブジェクトによって表される外部 ID セルフサービス サインアップ ユーザー フローに関連付けられている identityUserFlowAttribute オブジェクトを削除します。

プロパティ

プロパティ	型	説明
id	String	エンティティの一意識別子。 読み取り専用です。 エンティティから継承 されます。 自動生成。
displayName	String	必須です。 イベント ポリシーの表示名。
説明	String	イベント ポリシーの説明。
conditions	authenticationConditions	イベント ポリシーが呼び出されるかどうかを判断するために使用される認証要求のコンテキストを表す条件。 $filter (eq)をサポートしています。 構文については、「 ユーザー フローでのフィルター処理のサポート 」を参照してください。
priority	Int32	イベント ポリシーの個々のイベントに使用する優先順位。 1 つのイベントに対して競合する複数のリスナーが同じ優先順位を持つ場合は、1 つが選択され、エラーがサイレント ログに記録されます。 既定値は 500 です。

ユーザー フローでのフィルター処理のサポート

• identityProviders でフィルター処理します。 ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/any(idp:idp/id eq '{identityProvider-id}')
• 属性でフィルター処理する: ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/any(attribute:attribute/id eq '{attribute-ID}')
• リンクされたアプリケーションでフィルター処理する: ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/any(appId:appId/appId eq '{appId}')

リレーションシップ

なし。

JSON 表記

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

{
  "@odata.type": "#microsoft.graph.authenticationEventsFlow",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "priority": "Integer"
}