b2xUserFlows 资源类型b2xUserFlows resource type

命名空间:microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph 中的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported.

表示 Azure Active Directory 租户内的用户流。Represents a user flow within an Azure Active Directory tenant.

用户流用于在应用程序上为来宾用户提供自助注册体验。User flows are used to enable a self-service sign up experience for guest users on an application. 用户流定义最终用户注册时的体验,包括他们可以使用哪些标识提供者进行验证,以及在注册过程中收集哪些属性。User flows define the experience the end user sees while signing up, including which identity providers they can use to authenticate, along with which attributes are collected as part of the sign up process.

方法Methods

方法Method 返回类型Return Type 说明Description
列出用户流List user flows b2xUserFlow 集合b2xUserFlow collection 检索所有用户流。Retrieve all user flows.
获取用户流Get user flow b2xUserFlowb2xUserFlow 检索用户流的属性。Retrieve properties of a user flow.
创建用户流Create user flow b2xUserFlowb2xUserFlow 新建用户流。Create a new user flow.
删除用户流Delete user flow None 删除用户流。Delete a user flow.
列出标识提供者List identity providers identityProvider集合 identityProvider collection 检索用户流中的所有标识提供者。Retrieve all identity providers in a user flow.
添加标识提供者Add identity provider None 向用户流添加标识提供者。Add an identity provider to a user flow.
删除标识提供者Delete identity provider None 从用户流中删除标识提供者。Delete an identity provider from a user flow.

属性Properties

属性Property 类型Type 说明Description
idid StringString 用户流名称。The name of the user flow. 这是一个必需的值且在创建之后不可变。This is a required value and is immutable after it's created. 创建后,该名称将以 B2X_1_ 的值作为前缀。The name will be prefixed with the value of B2X_1_ after creation.
userFlowTypeuserFlowType 字符串String 用户流类型。The type of user flow. 对于自助注册用户流,该值在创建后只能 signUpOrSignIn,不能修改。For self-service sign up user flows, the value can only be signUpOrSignIn and cannot be modified after creation.
userFlowVersionuserFlowVersion 单一Single 用户流版本。The version of the user flow. 对于 B2X 用户流,版本始终是1For B2X user flows, the version is always 1.

关系Relationships

关系Relationship 类型Type 说明Description
identityProvidersidentityProviders identityProvider集合 identityProvider collection 用户流中包含的标识提供者。The identity providers included in the user flow.

JSON 表示形式JSON representation

下面是资源的 JSON 表示形式。The following is a JSON representation of the resource.

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}]
}