CreateCustomField - 创建扩展字段-应用身份服务 (IDaaS)(IDaaS)-阿里云帮助中心

创建扩展字段

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
EntityType	string	是	字段归属实体，取值可选范围： user：账户。	user
FieldName	string	是	字段标识名。最大长度限制为 40，内容格式可包含英文小写字母和下划线，不能以下划线开头。	field_001
FieldDisplayName	string	是	字段展示名。最大长度限制为 64。	name_001
FieldDisplayType	string	是	字段展示类型，取值可选范围： input：文本输入框。对应可选数据类型：string、number select：下拉框。对应可选数据类型：string、boolean checkbox：多选框。对应可选数据类型：string	input
FieldDataType	string	是	字段数据类型，取值可选范围： string：字符串。 number：数字，最大长度限制 32，支持正整数和小数。 boolean：布尔。	string
DefaultValue	string	否	字段默认值。若类型存在配置项，则默认值必须在配置项中且处于启用状态，最大长度限制为 1024。	string
FieldDataConfig	object	否	字段值配置项。
Items	array<object>	否	字段配置项列表。列表项最大限制数 100。	string
	object	否	字段配置项数据对象。
DisplayName	string	否	配置项展示名。最大长度限制为 128。	string
Value	string	否	配置项展示值。最大长度限制为 64。	string
Status	string	否	配置项状态，取值可选范围： enabled：启用。 disabled：禁用。配置项禁用，在创建和更新实体字段值时，该配置项不可用。	string
Unique	boolean	否	字段值是否唯一。设置为 true，则该字段的值在对应实体类型中唯一存在，不可重复。	false
Encrypted	boolean	否	是否加密。设置为 true，则底层会对数据值进行加密存储。	false
Required	boolean	否	是否必填。	false
UserPermission	string	否	portal 侧字段权限，取值可选范围： hide：portal 侧不可见。 read_only：portal 侧可见，不能编辑更新。 read_write：portal 侧可见且可编辑更新。	false
Description	string	否	字段描述。长度限制 512。	字段测试

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
FieldId	string	字段 ID。	ufd_001

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "FieldId": "ufd_001"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。