GetCustomField - Identity as a Service - Alibaba Cloud Documentation Center

Retrieves custom field information.

Operation description

Before using this operation, review the IDaaS pricing model and pricing details.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
FieldId	string	Yes	The field ID.	ufd_001

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
CustomField	object	Custom field information.
InstanceId	string	The instance ID.	idaas_z4pwq7v5ankdimdelzo2zbmzo4
FieldId	string	The field ID.	ufd_ncvy5trszg3zajaal5iofauy2q
EntityType	string	The entity type to which the field belongs.	user
FieldName	string	The field identifier.	userId
FieldDisplayName	string	The display name of the field.	userId
FieldDisplayType	string	The display type of the field. Valid values: input : input number : number select : select checkbox : checkbox	input
FieldDataType	string	The data type. Valid values: number : number boolean : boolean string : string	string
DefaultValue	string	The default value of the field.	test
FieldDataConfig	object	Field value configuration items.
Items	array<object>	A list of field configuration items.
	object	Custom field configuration.
DisplayName	string	The display name of the configuration item.	hobby
Value	string	The value of the configuration item.	game
Status	string	The status of the configuration item. Valid values: disabled : disabled enabled : enabled	enabled
Unique	boolean	Indicates whether the field is unique.	false
Encrypted	boolean	Indicates whether the field is encrypted.	false
Required	boolean	Indicates whether the field is required.	false
UserPermission	string	User-side (portal) permissions. Valid values: read_write : Editable hide : Hidden read_only : Visible	read_only
CreateTime	integer	The creation time of the custom field, in UNIX timestamp format in milliseconds.	17642960730
UpdateTime	integer	The last update time of the custom field, in UNIX timestamp format in milliseconds.	17642960730
Status	string	The status of the custom field. Valid values: disabled : disabled enabled : enabled	enabled
Description	string	The description of the custom field.	test

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.