用户

系统的统一用户管理入口

---

全文搜索用户列表

GET

/api/v1/user/search

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

username

类型string

fullName

类型string

mobile

类型string

email

类型string

source

类型string

枚举

"PLATFORM_SIGNUP""INVITATION_CODE_SIGNUP""BACKGROUND_SIGNUP""BACKGROUND_ADDED""THIRD_PARTY_LOGIN""LDAP_SYNCHRONIZE"

enabled

类型boolean

sysAdmin

类型boolean

createdDate

类型string

format"date-time"

tagId

类型integer

format"int64"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/user/search

试验场

授权

UserHttpBearer

变量

键

值

id

username

fullName

mobile

email

source

enabled

sysAdmin

createdDate

tagId

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

GET /api/v1/auth/user

GET

/api/v1/auth/user

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

响应

成功

Content-Type

*/*

{

"name": "string"

}

GET

/api/v1/auth/user

试验场

授权

UserHttpBearer

示例

cURL

JavaScript

PHP

Python

---

检查用户名是否存在

GET

/api/v1/user/username/check

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

username*

用户名

类型string

必填

minLength1

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/user/username/check

试验场

授权

UserHttpBearer

变量

键

值

username*

示例

cURL

JavaScript

PHP

Python

---

查询租户的系统管理员

GET

/api/v1/user/sysadmin

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/user/sysadmin

试验场

授权

UserHttpBearer

示例

cURL

JavaScript

PHP

Python

---

将用户设为系统管理员

PATCH

/api/v1/user/sysadmin

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/user/sysadmin

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询用户列表

GET

/api/v1/user

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

username

类型string

fullName

类型string

mobile

类型string

email

类型string

source

类型string

枚举

"PLATFORM_SIGNUP""INVITATION_CODE_SIGNUP""BACKGROUND_SIGNUP""BACKGROUND_ADDED""THIRD_PARTY_LOGIN""LDAP_SYNCHRONIZE"

enabled

类型boolean

sysAdmin

类型boolean

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

tagId

类型integer

format"int64"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/user

试验场

授权

UserHttpBearer

变量

键

值

id

username

fullName

mobile

email

source

enabled

sysAdmin

createdBy

createdDate

tagId

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

替换用户

PUT

/api/v1/user

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/user

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

添加用户

POST

/api/v1/user

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/user

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

删除用户

DELETE

/api/v1/user

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/user

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

更新用户

PATCH

/api/v1/user

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/user

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

启用或禁用用户

PATCH

/api/v1/user/enabled

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/user/enabled

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询用户详细信息

GET

/api/v1/user/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

用户ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/user/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

分布式锁或解锁用户

PATCH

/api/v1/user/locked

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/user/locked

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

撤销访问令牌

DELETE

/api/v1/auth/token

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

access_token*

类型string

必填

响应

成功

Content-Type

*/*

{

"additionalProperties": {

}

}

DELETE

/api/v1/auth/token

试验场

授权

UserHttpBearer

变量

键

值

access_token*

示例

cURL

JavaScript

PHP

Python

---