Skip to main content

ListTenant

调用该接口获取租户列表。

Request

get \tenants

Request Parameters

NameLocated inTypeDescriptionRequired
page_numqueryintegerfalse
page_sizequeryintegerfalse
order_byquerystringfalse
is_descendingquerybooleanfalse
key_wordsquerystringfalse

Response

Response 200

Code2DescriptionTypeSchema
200OKObjectv1ListTenantResponse

v1ListTenantResponse

NameTypeDescription
page_numinteger
page_sizeinteger
tenantsArray[v1TenantDetail]tenants [ 具体参数可见下面 v1TenantDetail ]
totalinteger

v1TenantDetail

NameTypeDescription
adminsArray[v1TenantAdmin]admins in tenant [ 具体参数可见下面 v1TenantAdmin ]
auth_typestringauth type : internal / external
created_atstringuser number in tenant
num_userintegeruser number in tenant
remarkstringtenant remark
rolesArray[ string ]user roles in tenant
tenant_idstringtenant id
titlestringtenant id

v1TenantAdmin

NameTypeDescription
passwordstringTenant Admin password
usernamestringTenant Admin username

Response default

Code2DescriptionTypeSchema
defaultAn unexpected error response.ObjectrpcStatus

rpcStatus

NameTypeDescription
codeinteger
detailsArray[protobufAny][ 具体参数可见下面 protobufAny ]
messagestring

protobufAny

NameTypeDescription
@typestring