b2cIdentityUserFlow リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Azure Active Directory B2C テナント内のユーザー フローを表します。
アプリケーションに最も一般的な ID タスクの設定をサポートするために、Azure Active Directory B2C には、ユーザー フローと呼ばれる、定義済みの構成可能なポリシーが用意されています。 ユーザー フローを使用すると、ユーザーがサインイン、サインアップ、プロファイルの編集、パスワードのリセットなどの操作を行った場合に、ユーザーがアプリケーションを操作する方法を判断できます。 テナントにさまざまな種類のユーザー フローを作成し、必要に応じてアプリケーションで使用できます。 ユーザー フローを使用して、次の機能を制御できます。
- サインインに使用するアカウントの種類 (Facebook やローカル アカウントなどのソーシャル アカウント)
- 姓、郵便番号、靴のサイズなど、消費者から収集する属性
- Azure 多要素認証
- ユーザー インターフェイスのカスタマイズ
- アプリケーションがトークンで受信する情報
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| ユーザー フローの一覧表示 | b2cIdentityUserFlow コレクション | すべての B2C ユーザー フローを取得します。 |
| ユーザー フローの取得 | b2cIdentityUserFlow | B2C ユーザー フローのプロパティを取得します。 |
| ユーザー フローの作成 | b2cIdentityUserFlow | 新しい B2C ユーザー フローを作成します。 |
| ユーザー フローの更新 | b2cIdentityUserFlow | B2C ユーザー フローのプロパティを更新します。 |
| ユーザー フローの削除 | None | B2C ユーザー フローを削除します。 |
| ID プロバイダーの一覧表示 | identityProvider コレクション | B2C ユーザー フローのすべての ID プロバイダーを取得します。 |
| ID プロバイダーの追加 | None | B2C ユーザー フローに ID プロバイダーを追加します。 |
| ID プロバイダーの削除 | なし | B2C ユーザー フローから ID プロバイダーを削除する |
| ユーザー属性の割り当てをリストする | identityUserFlowAttributeAssignment collection | B2C ユーザーフローのすべてのユーザー属性の割り当てを取得します。 |
| ユーザー属性の割り当てを作成する | identityUserFlowAttributeAssignment | B2C ユーザーフローのユーザー属性の割り当てを作成します。 |
| 言語をリストする | userFlowLanguageConfiguration コレクション | B2C ユーザー フロー内のすべての言語を取得します。 |
| 言語を作成する | userFlowLanguageConfiguration | B2C ユーザー フローでカスタム言語を作成します。 |
| ユーザーフロー用の API コネクタ構成を取得する | userFlowApiConnectorConfiguration | ユーザー フローで使用する API コネクタの構成を取得します。 このメソッドでは、$expand クエリ パラメーターがサポートされていません。 |
| ユーザー フローに API コネクタを構成する | None | apiConnectorConfiguration プロパティを更新することで、ユーザーフローの特定の手順について API コネクタを構成します。 |
| ID プロバイダーの一覧表示 (非推奨) | identityProvider コレクション | B2C ユーザー フローのすべての ID プロバイダーを取得します。 |
| ID プロバイダーの追加 (非推奨) | None | B2C ユーザー フローに ID プロバイダーを追加します。 |
| ID プロバイダーの削除 (非推奨) | なし | B2C ユーザー フローから ID プロバイダーを削除する |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| id | String | ユーザー フローの名前。 これは必須の値であり、作成後は変更できません。 作成後には、B2C_1_ の値を使用した名前が付けられます。 |
| userFlowType | userFlowType |
ユーザー フローの種類。
userFlowType でサポートされる値は signUp、signIn、signUpOrSignIn、passwordReset、profileUpdate、resourceOwner です。 |
| userFlowTypeVersion | Single | ユーザー フローのバージョン。 |
| isLanguageCustomizationEnabled | ブール値 | B2C ユーザー フロー内で言語のカスタマイズを有効にするかどうかを決定するプロパティ。 B2C ユーザー フローでは、言語のカスタマイズは既定で有効になっていません。 |
| defaultLanguageTag | String | リクエストで ui_locale タグが指定されていない場合に使用される b2cIdentityUserFlow の既定言語を示します。 このフィールドは RFC5646 に準拠しています。 |
| apiConnectorConfiguration | userFlowApiConnectorConfiguration | ユーザー フローの一部として使用するために API コネクタを有効にする構成。 Get userFlowApiConnectorConfigurationを使用して、このオブジェクトの値を取得することができます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| userFlowIdentityProviders | identityProviderBase コレクション | ユーザー フローに含まれている ID プロバイダー。 |
| identityProviders (非推奨) | identityProvider コレクション | ユーザー フローに含まれている ID プロバイダー。 |
| userAttributeAssignments | identityUserFlowAttributeAssignment コレクション | ユーザー フローに含まれるユーザー属性の割り当て。 |
| languages | userFlowLanguageConfiguration コレクション | ユーザー フロー内でのカスタマイズがサポートされている言語。 B2C ユーザー フローでは、言語のカスタマイズは既定で有効になっていません。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"id": "String (identifier)",
"userFlowType": "String",
"userFlowTypeVersion": "Single",
"isLanguageCustomizationEnabled": "Boolean",
"defaultLanguageTag": "String",
"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"
}
}