命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示 Azure Active Directory B2C 租户内的用户流。
为帮助你为应用程序设置最常见的标识任务,Azure Active Directory B2C 包含预定义的、可配置的策略,称为用户流。 用户流可用于确定用户在执行登录、注册、编辑配置文件或重置密码等操作时与应用程序交互的方式。 可在租户中创建许多不同类型的用户流,并根据需要在应用程序中使用它们。 可以使用用户流控制以下功能:
- 用于登录的帐户类型,如 Facebook 或本地帐户等社交帐户
 - 从消费者处收集的属性,例如姓名、邮政编码和鞋码
 - Azure Multi-Factor Authentication
 - 自定义用户界面
 - 应用程序在令牌中接收的信息
 
方法
| 方法 | 返回类型 | 说明 | 
|---|---|---|
| 列出用户流 | b2cIdentityUserFlow 集合 | 检索所 B2C 有用户流。 | 
| 获取用户流 | b2cIdentityUserFlow | 检索 B2C 用户流的属性。 | 
| 创建用户流 | b2cIdentityUserFlow | 新建 B2C 用户流。 | 
| 更新用户流 | b2cIdentityUserFlow | 更新 B2C 用户流的属性。 | 
| 删除用户流 | 无 | 删除 B2C 用户流。 | 
| 列出标识提供者 | identityProvider集合 | 检索 B2C 用户流中的所有标识提供者。 | 
| 添加标识提供者 | 无 | 向 B2C 用户流添加标识提供者。 | 
| 删除标识提供者 | 无 | 从 B2C 用户流中删除标识提供者 | 
| 列表用户属性作业 | identityUserFlowAttributeAssignment 集合 | 从 B2C 用户流中检索所有用户属性作业。 | 
| 创建用户属性作业 | identityUserFlowAttributeAssignment | 在 B2C 用户流中创建所有用户属性作业。 | 
| 列出语言 | userFlowLanguageConfiguration 集合 | 检索 B2X 用户流中的所有语言。 | 
| 创建语言 | userFlowLanguageConfiguration | 在 B2C 用户流中创建自定义语言。 | 
| 获取用户流的 API 连接器配置 | userFlowApiConnectorConfiguration | 获取用户流中所使用的 API 连接器的配置。 此方法不支持 $expand 查询参数。 | 
| 在用户流中配置 API 连接器 | 无 | 通过更新 apiConnectorConfiguration 属性,在用户流中按照特定步骤配置 API 连接器。 | 
| 列出标识提供者(已弃用) | identityProvider集合 | 检索 B2C 用户流中的所有标识提供者。 | 
| 添加标识提供者(已弃用) | 无 | 向 B2C 用户流添加标识提供者。 | 
| 删除标识提供者(已弃用) | 无 | 从 B2C 用户流中删除标识提供者 | 
属性
| 属性 | 类型 | 说明 | 
|---|---|---|
| id | String | 用户流名称。 这是一个必需的值且在创建之后不可变。 创建后,该名称将以 B2C_1_ 的值作为前缀。 | 
| userFlowType | userFlowType | 
              用户流类型。 userFlowType 支持 为: signUp、 signIn、 signUpOrSignIn、 passwordReset、 profileUpdate、 resourceOwner。 | 
| userFlowTypeVersion | 单一 | 用户流版本。 | 
| isLanguageCustomizationEnabled | Boolean | 此属性决定语言自定义是否在 B2C 用户流中启用。 默认情况下,语言自定义不会在 B2C 用户流中启用。 | 
| defaultLanguageTag | String | 指示在请求中没有指定 ui_locale 标签时使用的 b2cIdentityUserFlow 的默认语言。 此字段符合 RFC 5646。 | 
| apiConnectorConfiguration | userFlowApiConnectorConfiguration | 用于启用 API 连接器的配置,以便其可以成为用户流的一部分。 只能使用 Get userFlowApiConnectorConfiguration 获取此对象的值。 | 
关系
| 关系 | 类型 | 说明 | 
|---|---|---|
| userFlowIdentityProviders | identityProviderBase 集合 | 用户流中包含的标识提供者。 | 
| identityProviders(已弃用) | identityProvider集合 | 用户流中包含的标识提供者。 | 
| userAttributeAssignments | identityUserFlowAttributeAssignment 集合 | 包含在用户流内的用户属性作业。 | 
| 语言 | 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"
    }
}