1. 开发集成
  2. /
  3. 标准 Web 应用
  4. /
  5. Go
  6. /

  7. 管理模块

  8. /

  9. 自定义字段管理

  10. /
  11. 创建/修改自定义字段定义

创建/修改自定义字段定义

更新时间: 2024-10-10 07:28:40
编辑

创建/修改自定义字段定义，如果传入的 key 不存在则创建，存在则更新。

请求参数

名称类型必填默认值描述示例值
listSetCustomFieldDto[]是-自定义字段列表。

示例代码

package main

import (
    "github.com/Authing/authing-golang-sdk/management"
    "github.com/Authing/authing-golang-sdk/dto"

    "fmt"
)

func main() {
    options := management.ClientOptions {
        AccessKeyId:     "AUTHING_USERPOOL_ID",
        AccessKeySecret: "AUTHING_USERPOOL_SECRET",
    }

    client, err := management.NewClient(&options)
    if err != nil {
        // The exception needs to be handled by the developer.
    }

    response := client.setCustomFields(
      dto.SetCustomFieldsReqDto {
        List: []SetCustomFieldDto{
                    dto.SetCustomFieldDto
                    {
                     TargetType: SetCustomFieldDto.targetType.USER,
            DataType: SetCustomFieldDto.dataType.STRING,
            Key: "school",
            Label: "学校",
            Description: "学校",
            Encrypted: false,
          Options: []CustomFieldSelectOption{
                    dto.CustomFieldSelectOption
                    {
                     Value: "hust",
            Label: "华中科技大学",
                }
                  },
                }
                  },
    }
  )
}

请求响应

类型： CustomFieldListRespDto

名称类型描述
statusCodenumber业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
messagestring描述信息
apiCodenumber细分错误码，可通过此错误码得到具体的错误类型。
dataarray响应数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "targetType": "USER",
    "createdAt": "2022-03-17T05:23:01.567Z",
    "dataType": "STRING",
    "key": "school",
    "label": "学校",
    "description": "学校",
    "options": "[{\"value\":\"pku\",\"label\":\"北京大学\"}]"
  }
}

数据结构

SetCustomFieldDto

名称类型必填描述
targetTypestring是主体类型，目前支持用户、角色、分组和部门。 枚举值：USER,ROLE,GROUP,DEPARTMENT
dataTypestring是数据类型。 枚举值：STRING,NUMBER,DATETIME,BOOLEAN,SELECT
keystring是字段 key，不能和内置字段的 key 冲突。 示例值： school
labelstring是前端表单展示名称。 示例值： 学校
descriptionstring否详细描述信息。 示例值： 学校
encryptedboolean否是否加密存储。
optionsarray否枚举值类型选择项。嵌套类型：CustomFieldSelectOption。 示例值： [{"value":"pku","label":"北京大学"}]

CustomFieldSelectOption

名称类型必填描述
valuestring是枚举值 value。 示例值： hust
labelstring是枚举值 label。 示例值： 华中科技大学

CustomFieldDto

名称类型必填描述
targetTypestring是主体类型，目前支持用户、角色、分组和部门。 枚举值：USER,ROLE,GROUP,DEPARTMENT
createdAtstring是创建时间。 示例值： 2022-03-17T05:23:01.567Z
dataTypestring是数据类型。 枚举值：STRING,NUMBER,DATETIME,BOOLEAN,SELECT
keystring是字段 key，不能和内置字段的 key 冲突。 示例值： school
labelstring是前端表单展示名称。 示例值： 学校
descriptionstring否详细描述信息。 示例值： 学校
encryptedboolean否是否加密存储。
optionsarray否枚举值类型选择项。嵌套类型：CustomFieldSelectOption。 示例值： [{"value":"pku","label":"北京大学"}]

CustomFieldSelectOption

名称类型必填描述
valuestring是枚举值 value。 示例值： hust
labelstring是枚举值 label。 示例值： 华中科技大学