获取扩展字段信息
接口说明
请确保在使用该接口前，已充分了解 IDaaS EIAM 产品的收费方式和价格。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| FieldId |
string |
是 |
字段 ID。 |
ufd_001 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| CustomField |
object |
自定义字段信息。 |
|
| InstanceId |
string |
实例 ID。 |
idaas_z4pwq7v5ankdimdelzo2zbmzo4 |
| FieldId |
string |
字段 ID。 |
ufd_ncvy5trszg3zajaal5iofauy2q |
| EntityType |
string |
字段所属实体类型。 |
user |
| FieldName |
string |
字段标识。 |
userId |
| FieldDisplayName |
string |
字段展示名。 |
userId |
| FieldDisplayType |
string |
字段展示类型。 枚举值：
|
input |
| FieldDataType |
string |
数据类型。 枚举值：
|
string |
| DefaultValue |
string |
字段默认值。 |
test |
| FieldDataConfig |
object |
字段值配置项。 |
|
| Items |
array<object> |
字段配置项列表。 |
|
|
object |
自定义字段配置。 |
||
| DisplayName |
string |
配置项展示名。 |
hobby |
| Value |
string |
配置项值。 |
game |
| Status |
string |
配置项状态。 枚举值：
|
enabled |
| Unique |
boolean |
是否唯一。 |
false |
| Encrypted |
boolean |
是否加密。 |
false |
| Required |
boolean |
是否必填。 |
false |
| UserPermission |
string |
用户端(portal 侧)权限 枚举值：
|
read_only |
| CreateTime |
integer |
扩展字段创建时间，Unix 时间戳格式，单位为毫秒。 |
17642960730 |
| UpdateTime |
integer |
扩展字段最近一次更新时间, Unix 时间戳格式，单位为毫秒。 |
17642960730 |
| Status |
string |
扩展字段状态。 枚举值：
|
enabled |
| Description |
string |
扩展字段描述。 |
test |
示例
正常返回示例
JSON格式
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"CustomField": {
"InstanceId": "idaas_z4pwq7v5ankdimdelzo2zbmzo4",
"FieldId": "ufd_ncvy5trszg3zajaal5iofauy2q",
"EntityType": "user",
"FieldName": "userId",
"FieldDisplayName": "userId",
"FieldDisplayType": "input",
"FieldDataType": "string",
"DefaultValue": "test",
"FieldDataConfig": {
"Items": [
{
"DisplayName": "hobby",
"Value": "game",
"Status": "enabled"
}
]
},
"Unique": false,
"Encrypted": false,
"Required": false,
"UserPermission": "read_only",
"CreateTime": 17642960730,
"UpdateTime": 17642960730,
"Status": "enabled",
"Description": "test"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。