命名空间:microsoft.graph
创建新的自定义 identityUserFlowAttribute 对象。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
❌ |
❌ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
IdentityUserFlow.ReadWrite.All |
不可用。 |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
IdentityUserFlow.ReadWrite.All |
不可用。 |
重要
在具有工作或学校帐户的委托方案中,登录用户必须是组的所有者或成员,或者分配有受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。
外部 ID用户流属性管理员是此操作支持的最低特权角色。
HTTP 请求
POST /identity/userFlowAttributes
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供 identityUserFlowAttribute 的 JSON 表示形式。
属性 |
类型 |
说明 |
id |
String |
用户流属性的标识符。 这是一个自动创建的只读属性。 |
displayName |
String |
用户流属性的显示名称。 |
说明 |
String |
用户流属性的说明。 它会在注册时向用户显示。 |
userFlowAttributeType |
String |
用户流属性的类型。 这是一个自动设置的只读属性。 根据属性的类型,此属性 builtIn 的值为 或 custom 。 |
DataType |
String |
用户流属性的数据类型。 创建自定义用户流属性后,无法修改此属性。
dataType 支持的值有:
|
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和 identityUserFlowAttribute 对象。 如果失败,将返回错误 4xx
,其中包含特定详细信息。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/v1.0/identity/userFlowAttributes
Content-type: application/json
{
"displayName": "Hobby",
"description": "Your hobby",
"dataType": "string"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new IdentityUserFlowAttribute
{
DisplayName = "Hobby",
Description = "Your hobby",
DataType = IdentityUserFlowAttributeDataType.String,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.UserFlowAttributes.PostAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc identity user-flow-attributes create --body '{\
"displayName": "Hobby",\
"description": "Your hobby",\
"dataType": "string"\
}\
'
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewIdentityUserFlowAttribute()
displayName := "Hobby"
requestBody.SetDisplayName(&displayName)
description := "Your hobby"
requestBody.SetDescription(&description)
dataType := graphmodels.STRING_IDENTITYUSERFLOWATTRIBUTEDATATYPE
requestBody.SetDataType(&dataType)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
userFlowAttributes, err := graphClient.Identity().UserFlowAttributes().Post(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
IdentityUserFlowAttribute identityUserFlowAttribute = new IdentityUserFlowAttribute();
identityUserFlowAttribute.setDisplayName("Hobby");
identityUserFlowAttribute.setDescription("Your hobby");
identityUserFlowAttribute.setDataType(IdentityUserFlowAttributeDataType.String);
IdentityUserFlowAttribute result = graphClient.identity().userFlowAttributes().post(identityUserFlowAttribute);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const identityUserFlowAttribute = {
displayName: 'Hobby',
description: 'Your hobby',
dataType: 'string'
};
await client.api('/identity/userFlowAttributes')
.post(identityUserFlowAttribute);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\IdentityUserFlowAttribute;
use Microsoft\Graph\Generated\Models\IdentityUserFlowAttributeDataType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new IdentityUserFlowAttribute();
$requestBody->setDisplayName('Hobby');
$requestBody->setDescription('Your hobby');
$requestBody->setDataType(new IdentityUserFlowAttributeDataType('string'));
$result = $graphServiceClient->identity()->userFlowAttributes()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
displayName = "Hobby"
description = "Your hobby"
dataType = "string"
}
New-MgIdentityUserFlowAttribute -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.identity_user_flow_attribute import IdentityUserFlowAttribute
from msgraph.generated.models.identity_user_flow_attribute_data_type import IdentityUserFlowAttributeDataType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = IdentityUserFlowAttribute(
display_name = "Hobby",
description = "Your hobby",
data_type = IdentityUserFlowAttributeDataType.String,
)
result = await graph_client.identity.user_flow_attributes.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Location: "/identity/userFlowAttributes('extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby')"
Content-type: application/json
{
"id": "extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby",
"displayName": "Hobby",
"description": "Your hobby",
"userFlowAttributeType": "custom",
"dataType": "string"
}