XCan Cloud

English

简体中文

English

简体中文

Appearance

User​

Unified user management entry for the system.

Query the list of user​

GET
/api/v1/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型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

Page data size, default 1, maximum 100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

Page data size, default 10, maximum 2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
枚举
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string
枚举
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Replace user​

PUT
/api/v1/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"id": 1,
"username": "string",
"firstName": "James",
"lastName": "Jones",
"fullName": "James Jones",
"country": "CN",
"itc": 86,
"mobile": 13813000000,
"email": "james@xcan.cloud",
"landline": "010-88287890",
"password": "xcan@123",
"avatar": "http://prod-files.xcan.cloud/storage/pubapi/v1/file/logo.png",
"title": "CTO",
"gender": "MALE",
"address": "User's residence or contact address",
"signupType": "EMAIL",
"signupAccount": "Jams@123@xcan.cloud",
"sysAdmin": false,
"enabled": true,
"invitationCode": "string",
"depts": [
{
"id": 0,
"name": "string",
"mainDept": true,
"deptHead": true
}
],
"groupIds": [
0
],
"tagIds": [
0
]
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
主体

示例​

cURL
JavaScript
PHP
Python

Add user​

POST
/api/v1/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"username": "string",
"firstName": "James",
"lastName": "Jones",
"fullName": "James Jones",
"country": "CN",
"itc": 86,
"mobile": 13813000000,
"email": "james@xcan.cloud",
"landline": "010-88287890",
"password": "xcan@123",
"avatar": "http://prod-files.xcan.cloud/storage/pubapi/v1/file/logo.png",
"title": "CTO",
"gender": "MALE",
"address": "User's residence or contact address",
"signupType": "EMAIL",
"signupAccount": "Jams@123@xcan.cloud",
"sysAdmin": false,
"enabled": true,
"invitationCode": "string",
"depts": [
{
"id": 0,
"name": "string",
"mainDept": true,
"deptHead": true
}
],
"groupIds": [
0
],
"tagIds": [
0
]
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
主体

示例​

cURL
JavaScript
PHP
Python

Delete users​

DELETE
/api/v1/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

ids*
类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Update user​

PATCH
/api/v1/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"id": 0,
"username": "string",
"firstName": "James",
"lastName": "Jones",
"fullName": "James Jones",
"country": "CN",
"itc": 86,
"mobile": 13813000000,
"email": "james@xcan.cloud",
"landline": "010-88287890",
"avatar": "http://prod-files.xcan.cloud/storage/pubapi/v1/file/logo.png",
"title": "CTO",
"gender": "MALE",
"address": "User's residence or contact address",
"depts": [
{
"id": 0,
"name": "string",
"mainDept": true,
"deptHead": true
}
],
"groupIds": [
0
],
"tagIds": [
0
]
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
主体

示例​

cURL
JavaScript
PHP
Python

Query the system administrators of tenant​

GET
/api/v1/user/sysadmin

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权

示例​

cURL
JavaScript
PHP
Python

Set user as system administrator​

PATCH
/api/v1/user/sysadmin

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"id": 1,
"sysAdmin": false
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
主体

示例​

cURL
JavaScript
PHP
Python

DistributedLock or unlock user​

PATCH
/api/v1/user/locked

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"id": 1,
"locked": true,
"lockStartDate": "string",
"lockEndDate": "string"
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
主体

示例​

cURL
JavaScript
PHP
Python

Enable or disable users​

PATCH
/api/v1/user/enabled

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
{
"id": 1,
"enabled": true
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
主体

示例​

cURL
JavaScript
PHP
Python

Query the detail of user​

GET
/api/v1/user/{id}

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

User id

类型integer
必填
format"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Check whether or not username existed​

GET
/api/v1/user/username/check

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

username*

username

类型string
必填
minLength1

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Fulltext search the list of user​

GET
/api/v1/user/search

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型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

Page data size, default 1, maximum 100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

Page data size, default 10, maximum 2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
枚举
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string
枚举
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
服务器
授权
变量
键
值
cURL
JavaScript
PHP
Python

Query user authentication and authorization information​

GET
/api/v1/auth/user

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

响应​

OK

*/*
JSON
{
"name": "string"
}

试验场​

服务器
授权

示例​

cURL
JavaScript
PHP
Python

Revoke access token​

DELETE
/api/v1/auth/token

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

access_token*
类型string
必填

响应​

OK

*/*
JSON
{
"additionalProperties": {
}
}

试验场​

服务器
授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.

Copyright © 2021-2025 XCan Cloud

html>