All Products
Search

This Product

    Identity as a Service:CreateCustomField

    Document Center

    Identity as a Service:CreateCustomField

    Last Updated:Mar 24, 2026

    Creates an extension field.

    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
    EntityType

    string

    Yes

    The entity to which the field belongs. Valid value:

    • user: an account.

    user
    FieldName

    string

    Yes

    The name of the field. The name can be up to 40 characters in length and can contain lowercase letters and underscores (_). It cannot start with an underscore (_).

    field_001
    FieldDisplayName

    string

    Yes

    The display name of the field. The display name can be up to 64 characters in length.

    name_001
    FieldDisplayType

    string

    Yes

    The display type of the field. Valid values:

    • input: a text box. This display type supports the string and number data types.

    • select: a drop-down list. This display type supports the string and Boolean data types.

    • checkbox: a check box. This display type supports the string data type.

    input
    FieldDataType

    string

    Yes

    The data type of the field. Valid values:

    • string: a string.

    • number: a number. The number can be up to 32 digits in length and can be a positive integer or a decimal.

    • boolean: a Boolean value.

    string
    DefaultValue

    string

    No

    The default value of the field. If the field has configuration items, the default value must be one of the enabled configuration items. The default value can be up to 1024 characters in length.

    string
    FieldDataConfig

    object

    No

    The configuration items of the field value.

    Items

    array<object>

    No

    A list of field configuration items. The list can contain up to 100 items.

    string

    object

    No

    The data object of a field configuration item.

    DisplayName

    string

    No

    The display name of the configuration item. The display name can be up to 128 characters in length.

    string
    Value

    string

    No

    The value of the configuration item. The value can be up to 64 characters in length.

    string
    Status

    string

    No

    The status of the configuration item. Valid values:

    • enabled: The configuration item is enabled.

    • disabled: The configuration item is disabled.

    If a configuration item is disabled, it is unavailable when you create or update the field value for an entity.

    string
    Unique

    boolean

    No

    Indicates whether the field value is unique. If you set this parameter to true, the value of this field must be unique for the specified entity type.

    false
    Encrypted

    boolean

    No

    Indicates whether to encrypt the field value. If you set this parameter to true, the system encrypts the data value before storing it.

    false
    Required

    boolean

    No

    Indicates whether the field is required.

    false
    UserPermission

    string

    No

    The permission on the field in the portal. Valid values:

    • hide: The field is not visible in the portal.

    • read_only: The field is visible but cannot be modified in the portal.

    • read_write: The field is visible and can be modified in the portal.

    false
    Description

    string

    No

    The description of the field. The description can be up to 512 characters in length.

    Field test

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    FieldId

    string

    The field ID.

    ufd_001

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.