externalUsersSelfServiceSignUpEventsFlow リソースの種類

[アーティクル]
12/21/2023

名前空間: microsoft.graph

重要

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

Microsoft Entra従業員テナントまたは顧客テナント内の外部 ID のセルフサービスユーザーフローを表します。ユーザーフローは、特定のユーザー操作ポイントで特定のイベントを実行するマルチイベントポリシーとして実装されます。

authenticationEventsFlow から継承します。

メソッド

メソッド	戻り値の種類	説明
List	authenticationEventsFlow コレクション	authenticationEventsFlow オブジェクトとそのプロパティの一覧を取得します。
Create	externalUsersSelfServiceSignUpEventsFlow	外部 ID セルフサービスサインアップユーザーフローを作成します。
Get	externalUsersSelfServiceSignUpEventsFlow	外部 ID のセルフサービスサインアップユーザーフローのプロパティとリレーションシップを取得します。
Update	なし	外部 ID のセルフサービスサインアップユーザーフローのプロパティを更新する
Delete	なし	外部 ID のセルフサービスサインアップユーザーフローを削除します。
リンクされたアプリケーションを一覧表示する	authenticationConditionApplication コレクション	外部 ID セルフサービスサインアップユーザーフローに関連付けられているリスナーを一覧表示します。
リンクされたアプリケーションを追加する	なし	外部 ID セルフサービスサインアップユーザーフローに関連付けられているリスナーを一覧表示します。
リンクされたアプリケーションを削除する	なし	外部 ID セルフサービスサインアップユーザーフローに関連付けられているリスナーを一覧表示します。
ID プロバイダーの一覧表示	identityProvider コレクション	外部 ID セルフサービスサインアップユーザーフローに関連付けられている ID プロバイダーの選択を一覧表示します。
ID プロバイダーを追加する	なし	外部 ID セルフサービスサインアップユーザーフローに ID プロバイダーを追加します。
ID プロバイダーを削除する	なし	外部 ID セルフサービスサインアップユーザーフローから ID プロバイダーを削除します。
属性の一覧表示	identityUserFlowAttribute コレクション	外部 ID セルフサービスサインアップユーザーフローに関連付けられているすべてのユーザー属性を取得します。
属性を追加する	なし	外部 ID セルフサービスサインアップユーザーフローに関連付けられているすべてのユーザー属性を取得します。
属性を削除する	なし	外部 ID のセルフサービスサインアップユーザーフローからユーザーフロー属性を削除します。

プロパティ

プロパティ	型	説明
id	String	エンティティの一意識別子。読み取り専用です。エンティティから継承されます。
displayName	String	必須です。イベントポリシーの表示名。一意である必要があります。 authenticationEventsFlow から継承されます。
説明	String	省略可能。イベントポリシーの説明。 authenticationEventsFlow から継承されます。
conditions	authenticationConditions	省略可能です。イベントポリシーが呼び出されるかどうかを判断するために使用される認証要求のコンテキストを表す条件。 authenticationEventsFlow から継承されます。
priority	Int32	オプション。イベントポリシーの個々のイベントに使用する優先順位。 1 つのイベントに対して競合する複数のリスナーが同じ優先順位を持つ場合は、1 つが選択され、エラーがサイレントログに記録されます。既定値は 500 です。 authenticationEventsFlow から継承されます。
onInteractiveAuthFlowStart	onInteractiveAuthFlowStartHandler	必須です。認証フローを開始する準備ができたときに呼び出す内容の構成。
onAttributeCollection	onAttributeCollectionHandler	属性をユーザーから収集する準備ができたときに呼び出す内容の構成。
onAttributeCollectionStart	onAttributeCollectionStartHandler	属性コレクションが開始されたときに呼び出す内容の構成。
onAttributeCollectionSubmit	onAttributeCollectionSubmitHandler	属性が属性コレクションの最後に送信されたときに呼び出す内容の構成。
onAuthenticationMethodLoadStart	onAuthenticationMethodLoadStartHandler	必須です。認証方法をユーザーに提示する準備ができたときに呼び出す内容の構成。少なくとも 1 つの ID プロバイダーがリンクされている必要があります。
onUserCreateStart	onUserCreateStartHandler	ユーザーの作成時に呼び出す内容の構成。

リレーションシップ

なし。

JSON 表記

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

{
  "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "priority": "Integer",
  "onInteractiveAuthFlowStart": {
    "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler"
  },
  "onAuthenticationMethodLoadStart": {
    "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler"
  },
  "onAttributeCollection": {
    "@odata.type": "microsoft.graph.onAttributeCollectionHandler"
  },
  "onAttributeCollectionStart": {
    "@odata.type": "microsoft.graph.onAttributeCollectionStartHandler"
  },
  "onAttributeCollectionSubmit": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitHandler"
  },
  "onUserCreateStart": {
    "@odata.type": "microsoft.graph.onUserCreateStartHandler"
  }
}