b2xIdentityUserFlow リソースの種類

[アーティクル]
03/26/2023

名前空間: 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"
    }
}