跳到主要内容

ListUser

调用该接口查询用户列表。

Request​

get \tenants\{tenant_id}\users
NameLocated inTypeDescription
tenant_idpathstring

Request Parameters​

NameLocated inTypeDescriptionRequired
page_numqueryintegerfalse
page_sizequeryintegerfalse
order_byquerystringfalse
is_descendingquerybooleanfalse
key_wordsquerystringfalse

Response​

Response 200​

Code2DescriptionTypeSchema
200OKObjectv1ListUserResponse

v1ListUserResponse​

NameTypeDescription
page_numinteger
page_sizeinteger
totalinteger
usersArray[v1UserListData][ 具体参数可见下面 v1UserListData ]

v1UserListData​

NameTypeDescription
avatarstring
created_atstring
emailstring
external_idstring
nick_namestring
rolesArray[v1UserRole][ 具体参数可见下面 v1UserRole ]
tenant_idstring
user_idstring
usernamestring

v1UserRole​

NameTypeDescription
idstring
namestring

Response default​

Code2DescriptionTypeSchema
defaultAn unexpected error response.ObjectrpcStatus

rpcStatus​

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

protobufAny​

NameTypeDescription
@typestring