b2xIdentityUserFlow 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示Microsoft Entra租户中的自助注册用户流。

用户流用于在应用程序上为来宾用户提供自助注册体验。 用户流定义最终用户注册时的体验，包括他们可以使用哪些标识提供者进行验证，以及在注册过程中收集哪些属性。

方法

方法	返回类型	说明
列出用户流	b2xIdentityUserFlow 集合	检索所有 B2X 用户流。
获取用户流	b2xIdentityUserFlow	检索 B2X 用户流的属性。
创建用户流	b2xIdentityUserFlow	新建 B2X 用户流。
删除用户流	无	删除 B2X 用户流。
列出标识提供者	identityProvider集合	检索 B2X 用户流中的所有标识提供者。
添加标识提供者	无	向 B2X 用户流添加标识提供者。
删除标识提供者	无	从 B2X 用户流中删除标识提供者。
列出标识提供者（已弃用）	identityProvider集合	检索 B2X 用户流中的所有标识提供者。
添加标识提供者（已弃用）	无	向 B2X 用户流添加标识提供者。
删除标识提供者（已弃用）	无	从 B2X 用户流中删除标识提供者。
列出用户属性作业	identityUserFlowAttributeAssignment 集合	从 B2C 用户流中检索所有用户属性作业。
创建用户属性作业	identityUserFlowAttributeAssignment	在 B2C 用户流中创建一个用户属性作业。
列表语言	userFlowLanguageConfiguration 集合	检索 B2X 用户流中的所有语言。
获取用户流的 API 连接器配置	userFlowApiConnectorConfiguration	获取用户流中所使用的 API 连接器的配置。 此方法不支持$expand查询参数。
在用户流中配置 API 连接器	无	通过更新 apiConnectorConfiguration 属性，在用户流中按照特定步骤配置 API 连接器。

属性

属性	类型	说明
id	String	用户流名称。 这是一个必需的值且在创建之后不可变。 创建后，该名称将以 B2X_1_ 的值作为前缀。
userFlowType	userFlowType	用户流类型。 对于自助注册用户流，该值只能在 signUpOrSignIn 创建后修改且不能修改。
userFlowTypeVersion	单一	用户流版本。 对于自助式注册用户流，版本始终为 1。
apiConnectorConfiguration	userFlowApiConnectorConfiguration	配置，用于启用 API 连接器以作为自助式注册用户流的一部分。 只能使用 Get userFlowApiConnectorConfiguration 获取此对象的值。

关系

关系	类型	说明
userflowIdentityProviders	identityProviderBase 集合	用户流中包含的标识提供者。
identityProviders（已弃用）	identityProvider集合	用户流中包含的标识提供者。
userAttributeAssignments	identityUserFlowAttributeAssignment 集合	包含在用户流内的用户属性作业。
语言	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"
    }
}