添加自定义字段

POST

/api/v2/udfs/add

添加自定义字段

请求参数

Header 参数

Authorization

string

必需

用户池管理员 Token

示例值:

Bearer token

x-authing-userpool-id

string

用户池 ID

必需

示例值:

59f86b4832eb28071bdd9214

Body 参数application/json

targetType

string

必需

搜索目标类型，USER-用户，ROLE-角色，USERPOOL-用户池，PERMISSION-权限，APPLICATION-应用， RESOURCE-资源，ORG-组织机构，NODE-组织机构节点

dataType

string

必需

搜索的数据类型，STRING、NUMBER、DATETIME、BOOLEAN、OBJECT、SELECT

userVisible

boolean

可选

用户个人中心是否可见

adminVisible

boolean

控制台是否可见

可选

key

string

字段 Key

必需

label

string

显示名称

必需

options

object

其余参数

必需

validateRules

string

验证规则

可选

appIds

array[string]

应用 ID 列表

可选

encrypted

boolean

是否加密审计日志

可选

accessControl

boolean

可选

用户个人中心是否可编辑

description

string

字段说明

必需

示例

{
  "targetType": "string",
  "dataType": "string",
  "userVisible": true,
  "adminVisible": true,
  "key": "string",
  "label": "string",
  "options": {},
  "validateRules": "string",
  "appIds": [
    "string"
  ],
  "encrypted": true,
  "accessControl": true,
  "description": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://core.authing.cn/api/v2/udfs/add' \
--header 'Authorization: Bearer token' \
--header 'x-authing-userpool-id: 59f86b4832eb28071bdd9214' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

{
  "code": 200,
  "message": "操作成功"
}

修改于 2022-01-14 11:58:00

自定义字段列表查询

删除自定义字段