获取用户列表

获取用户列表

Query Parameters

filter string

过滤条件

order_by string

支持创建时间和更新时间排序

page_size int32

每页数量

page_token string

分页标识

include_admin boolean

是否包含管理员

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

users object[]
用户列表
Array [
id string
用户id
name string required
Possible values: non-empty and <= 64 characters
显示名称
username string required
Possible values: non-empty and <= 64 characters
用户名
phone string
手机号
email string
邮箱
tenant_id string
租户id
tenant_code string
租户标识
region_code string
地区代码
password string required
Possible values: >= 8 characters and <= 32 characters
密码
confirm_password string
确认密码
remark string
备注
console_state string required
控制台启用状态
open_api_state string required
open_api启用状态
mfa_state string required
mfa启用状态
set_password_first_login string required
是否首次登录时重置密码
set_password_next_login string
是否下次登录重置密码
set_password_at_login string
是否首次登录时重置密码
ak object
Ak
id string
Ak id
user_id string
用户id
access_key string
Access key
secret_key string
Secret key
status string
状态
advice_renew boolean
建议更新标志
password_updator_id string
上一次密码修改人id
password_updator_username string
上一次密码修改人用户名
]
next_page_token string

分页标识

total_size int32

数据总条数

{
  "users": [
    {
      "id": "string",
      "name": "string",
      "username": "string",
      "phone": "string",
      "email": "string",
      "tenant_id": "string",
      "tenant_code": "string",
      "region_code": "string",
      "status": "string",
      "source": "string",
      "confirm_password": "string",
      "remark": "string",
      "console_state": "string",
      "open_api_state": "string",
      "mfa_state": "string",
      "set_password_first_login": "string",
      "set_password_next_login": "string",
      "set_password_at_login": "string",
      "ak": {
        "id": "string",
        "user_id": "string",
        "access_key": "string",
        "secret_key": "string",
        "status": "string",
        "advice_renew": true,
        "create_time": "2024-12-05T02:41:59.130Z",
        "update_time": "2024-12-05T02:41:59.130Z"
      },
      "set_password_time": "2024-12-05T02:41:59.130Z",
      "last_login_time": "2024-12-05T02:41:59.130Z",
      "create_time": "2024-12-05T02:41:59.130Z",
      "update_time": "2024-12-05T02:41:59.130Z",
      "join_time": "2024-12-05T02:41:59.130Z",
      "password_updator_id": "string",
      "password_updator_username": "string",
      "invalid_time": "2024-12-05T02:41:59.130Z",
      "message_phone": "string",
      "message_email": "string",
      "message_phone_verified": true,
      "message_email_verified": true
    }
  ],
  "next_page_token": "string",
  "total_size": 0
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...