Get a list of custom fields

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If this document description is incorrect, please refer to the V3 API.

Get the list of custom fields for users, departments, or roles by subject type.

Method name

ManagementClient.getCustomFields

Request parameters

Name	Type	Is it required?	Default value	Description	Sample value
targetType	string	yes	-	Target object type: - USER: user - ROLE: role - GROUP: group - DEPARTMENT: department ; This interface does not support grouping (GROUP) yet	USER
tenantId	string	no	-	Tenant ID	642c1df417c2d8a80d744c1d

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.getCustomFields({
    targetType: "USER",
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: CustomFieldListRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	array	response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "targetType": "USER",
    "createdAt": "2022-03-17T05:23:01.567Z",
    "dataType": "ENUM",
    "key": "school",
    "label": "School",
    "description": "School",
    "visibleInAdminConsole": true,
    "visibleInUserCenter": true,
    "i18n": {
      "label": {
        "zh-CN": {
          "enabled": false,
          "value": "Chinese"
        },
        "en-US": {
          "enabled": false,
          "value": "English"
        },
        "zh-TW": {
          "enabled": false,
          "value": "繁體中文"
        }
      }
    },
    "options": "[{\"value\":\"pku\",\"label\":\"北大学\"}]"
  }
}

Data structure

CustomFieldDto

Name	Type	Is it required	Description	Example value
targetType	string	Yes	Target object type: - USER: User - ROLE: Role - GROUP: Group - DEPARTMENT: Department	USER
createdAt	string	No	Creation time, only valid for custom fields, built-in fields do not have creation time.	2022-03-17T05:23:01.567Z
dataType	string	Yes	Data type, cannot be modified after setting. - STRING: string type - NUMBER: number type - DATETIME: date type - BOOLEAN: Boolean type - ENUM: enumeration value type	STRING
key	string	yes	field key, cannot conflict with the key of built-in fields, cannot be modified after setting.	school
label	string	yes	display name	school
description	string	no	detailed description information	school
encrypted	boolean	no	whether to store encrypted. After enabling, newly added data of this field will be encrypted, and this parameter cannot be changed once set.
isUnique	boolean	yes	whether it is a unique field. After enabling, the value reported by the current field will be uniquely verified. This parameter is only valid for fields with data types of strings and numbers.
userEditable	boolean	no	Whether the user can edit it. If it is a special field such as mobile phone number or email address, the user cannot modify it directly and needs to verify it first through verification code or other methods.
visibleInAdminConsole	boolean	yes	Whether it needs to be displayed in the GenAuth console: - If it is a user-defined field, control whether it is displayed in the user details; - If it is a department-defined field, control whether it is displayed in the department details; - If it is a role extension field, control whether it is displayed in the role details.	true
visibleInUserCenter	boolean	no	Whether to display it in the user's personal center (this parameter does not control whether the API interface is returned).	true
i18n		no	Multilingual display name Nested type: <a CustomFieldI18n.	{"label":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English" },"zh-TW":{"enabled":false,"value":"Traditional Chinese"}}}
options	array	No	Enum value type options Nested type: <a CustomFieldSelectOption.	[{"value":"pku","label":"Peking University"}]

CustomFieldI18n

Name	Type	Required	Description	Example value
label		Yes	Fields that support multiple languages Nested type: <a LangObject.	{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"},"zh- TW":{"enabled":false,"value":"Traditional Chinese"},"ja-JP":{"enabled":false,"value":"Japanese"}}

LangObject

Name	Type	Required	Description	Example value
zh-CN		Yes	Multilingual Chinese content Nesting type: <a LangUnit.	{"enabled":false,"value":"中文"}
en-US		Yes	Multilingual English content Nested type: <a LangUnit.	{"enabled":false,"value":"English"}
zh-TW		Yes	Multilingual Traditional Chinese content Nesting type: <a LangUnit.	{"enabled":false,"value":"Traditional Chinese"}
ja-JP		Yes	Multilingual Japanese content Nested type: <a LangUnit.	{"enabled":false,"value":"日本语"}

LangUnit

Name	Type	Required	Description	Example value
enabled	boolean	Yes	Whether it is enabled. If enabled and the language is selected in the console, the content will be displayed. (off by default)
value	string	yes	multilingual content

CustomFieldSelectOption

Name	Type	Required	Description	Example value
value	string	Yes	enumeration value value	hust
label	string	yes	enumeration value label	Huazhong University of Science and Technology