b2xIdentityUserFlow 资源类型
命名空间:microsoft.graph
表示 Microsoft Entra 租户中的自助注册用户流。
用户流用于在应用程序上为来宾用户提供自助注册体验。 用户流定义最终用户在注册时看到的体验。 此体验包括可以使用哪些 标识提供者 进行身份验证,以及在注册过程中收集哪些属性。
继承自基类 identityUserFlow。
方法
方法 | 返回类型 | 说明 |
---|---|---|
列出用户流 | b2xIdentityUserFlow 集合 | 检索所有自助式注册用户流。 |
获取用户流 | b2xIdentityUserFlow | 检索自助式注册用户流的属性。 |
创建用户流 | b2xIdentityUserFlow | 创建新的自助式注册用户流。 |
删除用户流 | 无 | 删除自助式注册用户流。 |
列出标识提供者 | identityProvider集合 | 检索自助式注册用户流中所有标识提供程序。 |
添加标识提供者 | 无 | 向自助式注册用户流添加标识提供程序。 |
删除标识提供者 | 无 | 从自助式注册用户流中删除标识提供程序。 |
列表用户属性作业 | identityUserFlowAttributeAssignment 集合 | 检索自助式注册用户流中的所有用户属性分配。 |
创建用户属性作业 | identityUserFlowAttributeAssignment | 在自助式注册用户流中创建用户属性分配。 |
列出语言 | userFlowLanguageConfiguration 集合 | 检索自助式注册用户流内的所有语言。 |
获取用户流的 API 连接器配置 | userFlowApiConnectorConfiguration | 获取自助式注册用户流中使用的 API 连接器的配置。 此方法不支持$expand查询参数。 |
在用户流中配置 API 连接器 | 无 | 通过更新 apiConneconfiguration 属性的 apiConneconfiguration API 连接器。 |
属性
属性 | 类型 | 说明 |
---|---|---|
apiConnectorConfiguration | userFlowApiConnectorConfiguration | 配置,用于启用 API 连接器以作为自助式注册用户流的一部分。 只能使用 Get userFlowApiConnectorConfiguration 获取此对象的值。 |
id | String | 用户流的名称是必需值,在创建后是不可变的。 创建后,该名称将以 B2X_1_ 的值作为前缀。 |
userFlowType | userFlowType | 用户流类型。 对于自助注册用户流,该值只能在 signUpOrSignIn 创建后修改且不能修改。 |
userFlowTypeVersion | 单一 | 用户流版本。 对于自助式注册用户流,版本始终为 1 。 |
关系
关系 | 类型 | 说明 |
---|---|---|
identityProviders | identityProvider集合 | 用户流中包含的标识提供者。 |
语言 | userFlowLanguageConfiguration 集合 | 用户流中的支持自定义的语言。 默认情况下,自助式注册用户流中启用了语言自定义。 无法在自助注册用户流中创建自定义语言。 |
userAttributeAssignments | identityUserFlowAttributeAssignment 集合 | 包含在用户流内的用户属性作业。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"apiConnectorConfiguration": {
"@odata.type": "microsoft.graph.userFlowApiConnectorConfiguration"
},
"id": "String (identifier)",
"identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}],
"languages": [{"@odata.type": "microsoft.graph.userFlowLanguageConfiguration"}],
"userAttributeAssignments": [{"@odate.type": "microsoft.graph.identityUserFlowAttributeAssignment"}],
"userFlowType": "String",
"userFlowTypeVersion": "Single"
}