Tenant

Unified tenant management. Centralizes tenant account controls, configurations, and initialize access permissions, etc

---

Query the list of tenant

GET

/api/v1/tenant

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

name

类型string

no

类型string

type

类型string

枚举

"PERSONAL""ENTERPRISE""GOVERNMENT""UNKNOWN"

status

类型string

枚举

"DISABLED""CANCELLING""CANCELED""ENABLED"

realNameStatus

类型string

枚举

"NOT_SUBMITTED""AUDITING""AUDITED""FAILED_AUDIT"

locked

类型boolean

createdDate

类型string

format"date-time"

applyCancelDate

类型string

format"date-time"

lastLockDate

类型string

format"date-time"

lockStartDate

类型string

format"date-time"

lockEndDate

类型string

format"date-time"

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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/tenant

试验场

服务器

授权

UserHttpBearer

变量

键

值

id

name

no

type

status

realNameStatus

locked

createdDate

applyCancelDate

lastLockDate

lockStartDate

lockEndDate

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

---

Replace tenant

PUT

/api/v1/tenant

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"name": "XCan Company",

"type": "string",

"remark": "string",

"address": "string",

"firstName": "James",

"lastName": "Jones",

"fullName": "James Jones",

"title": "CTO",

"itc": 86,

"country": "CN",

"mobile": 13813000000,

"email": "james@xcan.cloud",

"personalCert": {

"name": "string",

"certNo": "string",

"certFrontPicUrl": "string",

"certBackPicUrl": "string"

},

"enterpriseCert": {

"name": "string",

"creditCode": "string",

"businessLicensePicUrl": "string"

},

"enterpriseLegalPersonCert": {

"name": "string",

"certNo": "string",

"certFrontPicUrl": "string",

"certBackPicUrl": "string"

},

"governmentCert": {

"name": "string",

"orgCode": "string",

"orgCertPicUrl": "string"

},

"certSubmitted": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/tenant

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add tenant

POST

/api/v1/tenant

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"type": "string",

"name": "XCan Company",

"remark": "string",

"address": "Tenant contact address.",

"firstName": "James",

"lastName": "Jones",

"fullName": "James Jones",

"title": "CTO",

"itc": 86,

"country": "CN",

"mobile": 13813000000,

"email": "james@xcan.cloud",

"password": "Password@123",

"personalCert": {

"name": "string",

"certNo": "string",

"certFrontPicUrl": "string",

"certBackPicUrl": "string"

},

"enterpriseCert": {

"name": "string",

"creditCode": "string",

"businessLicensePicUrl": "string"

},

"enterpriseLegalPersonCert": {

"name": "string",

"certNo": "string",

"certFrontPicUrl": "string",

"certBackPicUrl": "string"

},

"governmentCert": {

"name": "string",

"orgCode": "string",

"orgCertPicUrl": "string"

},

"certSubmitted": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/tenant

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Update tenant

PATCH

/api/v1/tenant

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"name": "XCan Company",

"type": "string",

"remark": "string",

"address": "string",

"firstName": "James",

"lastName": "Jones",

"fullName": "James Jones",

"title": "CTO",

"itc": 86,

"country": "CN",

"mobile": 13813000000,

"email": "james@xcan.cloud",

"personalCert": {

"name": "string",

"certNo": "string",

"certFrontPicUrl": "string",

"certBackPicUrl": "string"

},

"enterpriseCert": {

"name": "string",

"creditCode": "string",

"businessLicensePicUrl": "string"

},

"enterpriseLegalPersonCert": {

"name": "string",

"certNo": "string",

"certFrontPicUrl": "string",

"certBackPicUrl": "string"

},

"governmentCert": {

"name": "string",

"orgCode": "string",

"orgCertPicUrl": "string"

},

"certSubmitted": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/tenant

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add tenant through mobile signup

POST

/api/v1/tenant/signupByMobile

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"name": "XCan Company",

"firstName": "James",

"lastName": "Jones",

"fullName": "James Jones",

"itc": 86,

"country": "CN",

"mobile": 13813000000,

"email": "james@xcan.cloud",

"password": "Password@123"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/tenant/signupByMobile

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

DistributedLock or unlock tenant

PATCH

/api/v1/tenant/locked

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"locked": true,

"lockStartDate": "2022-04-01 12:00:00",

"lockEndDate": "2023-06-01 12:00:00"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/tenant/locked

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Enable or disable tenant

PATCH

/api/v1/tenant/enabled

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"enabled": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/tenant/enabled

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of tenant

GET

/api/v1/tenant/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Tenant id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/tenant/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search tenant

GET

/api/v1/tenant/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

name

类型string

no

类型string

type

类型string

枚举

"PERSONAL""ENTERPRISE""GOVERNMENT""UNKNOWN"

status

类型string

枚举

"DISABLED""CANCELLING""CANCELED""ENABLED"

realNameStatus

类型string

枚举

"NOT_SUBMITTED""AUDITING""AUDITED""FAILED_AUDIT"

locked

类型boolean

createdDate

类型string

format"date-time"

applyCancelDate

类型string

format"date-time"

lastLockDate

类型string

format"date-time"

lockStartDate

类型string

format"date-time"

lockEndDate

类型string

format"date-time"

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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/tenant/search

试验场

服务器

授权

UserHttpBearer

变量

键

值

id

name

no

type

status

realNameStatus

locked

createdDate

applyCancelDate

lastLockDate

lockStartDate

lockEndDate

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

---