Modify user built-in field configuration
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.
Modify user built-in field configuration. Built-in fields are not allowed to modify data types and uniqueness.
Method name
ManagementClient.setUserBaseFields
Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| list | <a SetUserBaseFieldDto[] | Yes | - | Custom field list Array length limit: 50. |
Sample code
ts
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.setUserBaseFields({
list: [
{
key: "school",
label: "学校",
description: "学校",
userEditable: false,
visibleInAdminConsole: true,
visibleInUserCenter: true,
i18n: {
label: {
"zh-CN": {
enabled: false,
value: "中文",
},
"en-US": {
enabled: false,
value: "英文",
},
"zh-TW": {
enabled: false,
value: "繁體",
},
"ja-JP": {
enabled: false,
value: "日本文",
},
},
},
],
});
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 (not returned for successful requests). 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:
json
{
"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\":\"Peking University\"}]"
}
}Data structure
SetUserBaseFieldDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| key | string | Yes | Field key, cannot conflict with the key of built-in fields, cannot be modified after setting. | school |
| label | string | no | Display name | school |
| description | string | no | Detailed description | school |
| userEditable | boolean | no | Editable by user | |
| visibleInAdminConsole | boolean | no | Whether to display in the GenAuth console: - If it is a user-defined field, control whether to display in user details; - If it is a department-defined field, control whether to display in department details; - If it is a role extension field, control whether to display in role details. | true |
| visibleInUserCenter | boolean | no | Whether to display in the user's personal center (this parameter does not control whether the API interface is returned). | true |
| i18n | no | Multi-language display name Nested type: <a CustomFieldI18n. | {"label":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"},"zh-TW":{"enabled":false,"value":"繁體中文"}}} |
CustomFieldI18n
| Name | Type | Is it required? | Description | Sample 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":"繁體中文"},"ja-JP":{"enabled":false,"value":"日本語"}} |
LangObject
| Name | Type | Required | Description | Sample value |
|---|---|---|---|---|
| zh-CN | Yes | Multilingual Chinese content Nested 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 |
CustomFieldDto
| Name | Type | 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 have no creation time. | 2022-03-17T05:23:01.567Z |
| dataType | string | Yes | data type, cannot be modified after setting. - STRING: string type- NUMBER: numeric type- DATETIME: date type- BOOLEAN: boolean type- ENUM: enum Value type | STRING |
| key | string | is the | field key and cannot conflict with the key of the built-in field. It cannot be modified after it is set. | school |
| label | string | yes | display name | school |
| description | string | No | Detailed description information | school |
| encrypted | boolean | No | Whether to encrypt storage. When turned on, the new data in this field will be encrypted. Once this parameter is set, it cannot be changed. | |
| isUnique | boolean | Yes | Whether it is a unique field. After turning it on, the value reported by the current field will be uniquely verified. This parameter is only valid for fields whose data type is string and number. | |
| 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":"繁體中文"}}} | |
| options | array | No | Enumeration value type selection Nested type: <a CustomFieldSelectOption. | [{"value":"pku","label":"Peking University"}] |
CustomFieldI18n
| Name | Type | Is it required? | Description | Sample 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":"繁體中文"},"ja-JP":{"enabled":false,"value":"日本語"}} |
LangObject
| Name | Type | Required | Description | Sample value |
|---|---|---|---|---|
| zh-CN | Yes | Multilingual Chinese content Nested type: <a LangUnit. | {"enabled":false,"value":"中文"} | |
| en-US | Yes | Multilingual English content Nesting type: <a LangUnit. | {"enabled":false,"value":"English"} | |
| zh-TW | Yes | Multilingual Traditional Chinese content Nesting type: <a LangUnit. | {"enabled":false,"value":"繁體中文"} | |
| ja-JP | Yes | Multilingual Japanese content Nesting type: <a LangUnit. | {"enabled":false,"value":"日本語"} |
LangUnit
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| enabled | boolean | yes | Is it enabled? If enabled, and the console selects this language, the content will be displayed. (Closed by default) | |
| value | string | yes | Multilingual content |
CustomFieldSelectOption
| Name | Type | Is it required | Description | Sample value |
|---|---|---|---|---|
| value | string | yes | enumeration value value | hust |
| label | string | yes | enumeration value label | Huazhong University of Science and Technology |