b2xIdentityUserFlow リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft Entra テナント内のセルフサービス サインアップ ユーザー フローを表します。
ユーザー フローは、アプリケーションのゲスト ユーザーが セルフサービスのサインアップ 環境を有効にするために使用されます。 ユーザー フローは、サインアップ時にエンド ユーザーに表示されるエクスペリエンスを定義します。 このエクスペリエンスには、認証に使用できる ID プロバイダー と、サインアップ プロセスの一環として収集される属性が含まれます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| ユーザー フローの一覧表示 | b2xIdentityUserFlow コレクション | すべての B2X ユーザー フローを取得します。 |
| ユーザー フローの取得 | b2xIdentityUserFlow | B2X ユーザー フローのプロパティを取得します。 |
| ユーザー フローの作成 | b2xIdentityUserFlow | 新しい B2X ユーザー フローを作成します。 |
| ユーザー フローの削除 | None | B2X ユーザー フローを削除します。 |
| ID プロバイダーの一覧表示 | identityProvider コレクション | B2X ユーザー フローのすべての ID プロバイダーを取得します。 |
| ID プロバイダーの追加 | None | B2X ユーザー フローに ID プロバイダーを追加します。 |
| ID プロバイダーの削除 | None | B2X ユーザー フローから ID プロバイダーを削除します。 |
| ID プロバイダーの一覧表示 (非推奨) | identityProvider コレクション | B2X ユーザー フローのすべての ID プロバイダーを取得します。 |
| ID プロバイダーの追加 (非推奨) | None | B2X ユーザー フローに ID プロバイダーを追加します。 |
| ID プロバイダーの削除 (非推奨) | None | B2X ユーザー フローから ID プロバイダーを削除します。 |
| ユーザー属性の割り当てをリストする | identityUserFlowAttributeAssignment コレクション | B2X ユーザー フローのすべてのユーザー属性の割り当てを取得します。 |
| ユーザー属性の割り当てを作成する | identityUserFlowAttributeAssignment | B2X ユーザー フローのユーザー属性の割り当てを作成します。 |
| 言語をリストする | userFlowLanguageConfiguration コレクション | B2X ユーザー フロー内のすべての言語を取得します。 |
| ユーザーフロー用の API コネクタ構成を取得する | userFlowApiConnectorConfiguration | ユーザー フローで使用する API コネクタの構成を取得します。 $expand クエリ パラメーターは、このメソッドではサポートされていません。 |
| ユーザー フローに API コネクタを構成する | None | apiConnectorConfiguration プロパティを更新することで、ユーザーフローの特定の手順について API コネクタを構成します。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| id | String | ユーザー フローの名前。 これは必須の値であり、作成後は変更できません。 作成後には、B2X_1_ の値を使用した名前が付けられます。 |
| userFlowType | userFlowType | ユーザー フローの種類。 セルフサービス サインアップ ユーザー フローの場合、値は signUpOrSignIn 、作成後にのみ可能であり、変更できません。 |
| userFlowTypeVersion | Single | ユーザー フローのバージョン。 セルフサービス サインアップ ユーザー フローの場合、バージョンは常に 1 です。 |
| apiConnectorConfiguration | userFlowApiConnectorConfiguration | セルフサービス サインアップ ユーザー フローの一部として使用するために API コネクタを有効にする構成。 Get userFlowApiConnectorConfigurationを使用して、このオブジェクトの値を取得することができます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| userflowIdentityProviders | identityProviderBase コレクション | ユーザー フローに含まれている ID プロバイダー。 |
| identityProviders (非推奨) | identityProvider コレクション | ユーザー フローに含まれている ID プロバイダー。 |
| userAttributeAssignments | identityUserFlowAttributeAssignment コレクション | ユーザー フローに含まれるユーザー属性の割り当て。 |
| languages | userFlowLanguageConfiguration コレクション | ユーザー フロー内でのカスタマイズがサポートされている言語。 セルフサービス サインアップ ユーザー フローでは、既定で言語のカスタマイズが有効になります。 セルフサービス サインアップ ユーザー フローでカスタム言語を作成することはできません。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"id": "String (identifier)",
"userFlowType": "String",
"userFlowTypeVersion": "Single",
"userflowIdentityProviders": [{"@odata.type": "microsoft.graph.identityProviderBase"}],
"identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}],
"userAttributeAssignments": [{"@odate.type": "microsoft.graph.identityUserFlowAttributeAssignment"}],
"languages": [{"@odata.type": "microsoft.graph.userFlowLanguageConfiguration"}],
"apiConnectorConfiguration": {
"@odata.type": "microsoft.graph.userFlowApiConnectorConfiguration"
}
}