创建 userAttributeAssignments

  • 项目

命名空间：microsoft.graph

在 b2xIdentityUserFlow 中创建新的 identityUserFlowAttributeAssignment 对象。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） IdentityUserFlow.ReadWrite.All 不可用。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 IdentityUserFlow.ReadWrite.All 不可用。

HTTP 请求

POST /identity/b2xUserFlows/{id}/userAttributeAssignments

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中，提供 identityUserFlowAttributeAssignment 对象的 JSON 表示形式。

下表列出了创建 identityUserFlowAttributeAssignment 时所需的属性。

属性 类型 说明
displayName String 用户流中 identityUserFlowAttribute 的显示名称。
isOptional 布尔值 确定 identityUserFlowAttribute 是否可选。 true 表示用户不必提供值。 false 表示用户在未提供值的情况下无法完成注册。
requiresVerification 布尔值 确定 identityUserFlowAttribute 是否需要验证。 这仅用于验证用户的电话号码或电子邮件地址。
userAttributeValues userAttributeValuesItem 集合 用户流属性的输入选项。 仅当 userInputType 为 radioSingleSelect、 dropdownSingleSelect或 checkboxMultiSelect时适用。
userInputType identityUserFlowAttributeInputType 用户流属性的输入类型。 可取值为：textBox、dateTimeDropdown、radioSingleSelect、dropdownSingleSelect、emailBox、checkboxMultiSelect。
userAttribute identityUserFlowAttribute 要包含在用户流分配中的用户流属性的标识符。

响应

如果成功，此方法在 201 Created 响应正文中返回响应代码和 identityUserFlowAttributeAssignment 对象。

示例

请求

POST https://graph.microsoft.com/beta/identity/b2xUserFlows/B2X_1_Partner/userAttributeAssignments
Content-Type: application/json

{
    "isOptional": false,
    "requiresVerification": false,
    "userInputType": "TextBox",
    "displayName": "Shoe size",
    "userAttributeValues": [],
    "userAttribute": {
        "id": "extension_guid_shoeSize"
    }
}

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/beta/identity/b2xUserFlows/B2X_1_Partner/userAttributeAssignments/extension_guid_shoeSize
Content-Type: application/json

{
    "id": "extension_guid_shoeSize",
    "isOptional": false,
    "requiresVerification": false,
    "userInputType": "TextBox",
    "displayName": "Shoe size",
    "userAttributeValues": []
}