自定义字段列表查询 - Authing 开放 API

搜索用户池用户自定义字段列表，可在「控制台-设置-字段管理」里查看对应搜索功能

请求参数

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

isBase

boolean

必需

是否是基础字段，为 false 标识搜索的是扩展字段

page

integer

页数

可选

limit

integer

每页显示条数

可选

userVisible

boolean

可选

用户个人中心是否可见

adminVisible

boolean

控制台是否可见

可选

accessControl

boolean

可选

用户个人中心是否可编辑

keyword

string

搜索关键字

可选

示例

{
    "targetType": "string",
    "dataType": "string",
    "isBase": true,
    "page": 0,
    "limit": 0,
    "userVisible": true,
    "adminVisible": true,
    "accessControl": true,
    "keyword": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

count

object

必需

list

array [object {13}]

必需

示例

{
    "code": 200,
    "message": "获取成功",
    "data": {
        "count": {
            "all": 7,
            "userVisible": 0,
            "adminVisible": 0
        },
        "list": [
            {
                "key": "name",
                "label": "姓名",
                "labelEn": "Name",
                "description": "OIDC 标准字段",
                "dataType": "STRING",
                "options": null,
                "userPoolId": "59f86b4832eb28071bdd9214",
                "targetType": "USER",
                "userVisible": true,
                "adminVisible": true,
                "accessControl": true,
                "validateRules": null,
                "isBase": true
            },
            {
                "key": "username",
                "label": "用户名",
                "labelEn": "Username",
                "description": "用户名，用户池内唯一，区分大小写",
                "dataType": "STRING",
                "options": null,
                "userPoolId": "59f86b4832eb28071bdd9214",
                "targetType": "USER",
                "userVisible": true,
                "adminVisible": true,
                "accessControl": true,
                "validateRules": [
                    {
                        "type": "UNIQUE",
                        "content": "",
                        "error": "邮箱值重复"
                    }
                ],
                "isBase": true
            },
            {
                "key": "nickname",
                "label": "昵称",
                "labelEn": "Nickname",
                "description": "用户昵称，该字段不具备唯一性。",
                "dataType": "STRING",
                "options": null,
                "userPoolId": "59f86b4832eb28071bdd9214",
                "targetType": "USER",
                "userVisible": true,
                "adminVisible": true,
                "accessControl": true,
                "validateRules": null,
                "isBase": true
            },
            {
                "key": "givenName",
                "label": "Given Name",
                "labelEn": "Given Name",
                "description": "OIDC 标准字段",
                "dataType": "STRING",
                "options": null,
                "userPoolId": "59f86b4832eb28071bdd9214",
                "targetType": "USER",
                "userVisible": false,
                "adminVisible": false,
                "accessControl": true,
                "validateRules": null,
                "isBase": true
            },
            {
                "key": "familyName",
                "label": "Family Name",
                "labelEn": "Famliy Name",
                "description": "OIDC 标准字段",
                "dataType": "STRING",
                "options": null,
                "userPoolId": "59f86b4832eb28071bdd9214",
                "targetType": "USER",
                "userVisible": false,
                "adminVisible": false,
                "accessControl": true,
                "validateRules": null,
                "isBase": true
            },
            {
                "key": "middleName",
                "label": "Middle Name",
                "labelEn": "Middle Name",
                "description": "OIDC 标准字段",
                "dataType": "STRING",
                "options": null,
                "userPoolId": "59f86b4832eb28071bdd9214",
                "targetType": "USER",
                "userVisible": false,
                "adminVisible": false,
                "accessControl": true,
                "validateRules": null,
                "isBase": true
            },
            {
                "key": "preferredUsername",
                "label": "Preferred Username",
                "labelEn": "Preferred Username",
                "description": "OIDC 标准字段",
                "dataType": "STRING",
                "options": null,
                "userPoolId": "59f86b4832eb28071bdd9214",
                "targetType": "USER",
                "userVisible": false,
                "adminVisible": false,
                "accessControl": true,
                "validateRules": null,
                "isBase": true
            }
        ]
    }
}