跳到主要内容

用户管理

控制台客户端配置 · 返回值与共享类型

用户操作使用目标应用的 appId。list 返回分页数据,search 返回选人列表。requireOriginId=true 只搜索具有业务侧用户标识的用户。setStatus 接受 active 或 disabled。

issueToken 通过控制台接口签发课堂用户凭证。应用凭证客户端的 client.auth.issueToken 则在本地使用应用密钥签名;两种入口返回的课堂凭证与控制台租户登录令牌用途不同。

应用后端使用应用业务接口和应用凭证。本页描述独立的租户管理调用。

users.list​

用户列表。

GET /v1/users

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.users.list(appId, input)
Pythonc.users.list(app_id, **input)
Javac.users.list(appId, input)
Goc.Users.List(ctx, appID, input, &result)
PHP$c->users->list($appId, $input)

输入:ListEduUsersQuery。 字段放在 URL 查询参数中。

字段必填类型说明
status否EduUserStatus | undefined状态筛选或目标状态
q否string | undefined搜索关键词
page否number | undefined页码,从 1 开始
pageSize否number | undefined单页数量

返回:ListEduUsersResult。嵌套字段见共享类型。

users.search​

搜索用户。

GET /v1/users/search

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.users.search(appId, input)
Pythonc.users.search(app_id, **input)
Javac.users.search(appId, input)
Goc.Users.Search(ctx, appID, input, &result)
PHP$c->users->search($appId, $input)

输入:SearchEduUsersQuery。 字段放在 URL 查询参数中。

字段必填类型说明
q否string | undefined搜索关键词
status否EduUserStatus | undefined状态筛选或目标状态
limit否number | undefined搜索结果数量上限,最大 50
requireOriginId否boolean | undefined只返回有业务侧标识的用户

返回:SearchEduUsersResult。嵌套字段见共享类型。

users.create​

创建用户。

POST /v1/users

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.users.create(appId, input)
Pythonc.users.create(app_id, **input)
Javac.users.create(appId, input)
Goc.Users.Create(ctx, appID, input, &result)
PHP$c->users->create($appId, $input)

输入:CreateEduUserPayload。 字段放在 JSON Body 中。

字段必填类型说明
originId否string | undefined业务侧用户标识
nickname是string用户昵称
avatar是string头像 URL

返回:EduUserRecord。嵌套字段见共享类型。

users.setStatus​

启用或停用用户。

PATCH /v1/users/status

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.users.setStatus(appId, input)
Pythonc.users.set_status(app_id, **input)
Javac.users.setStatus(appId, input)
Goc.Users.SetStatus(ctx, appID, input, &result)
PHP$c->users->setStatus($appId, $input)

输入:UserStatusInput。 字段放在 JSON Body 中。

字段必填类型说明
eduUserId是string课堂用户 ID
status是EduUserStatus状态筛选或目标状态

返回:EduUserRecord。嵌套字段见共享类型。

users.issueToken​

签发用户 Token。

POST /v1/users/token

鉴权:租户 Bearer Token 与 x-app-id。

语言调用
Node.jsc.users.issueToken(appId, input)
Pythonc.users.issue_token(app_id, **input)
Javac.users.issueToken(appId, input)
Goc.Users.IssueToken(ctx, appID, input, &result)
PHP$c->users->issueToken($appId, $input)

输入:UserTokenInput。 字段放在 JSON Body 中。

字段必填类型说明
eduUserId是string课堂用户 ID
expiresIn否number | undefined用户 Token 有效秒数,60–604800

返回:EduUserTokenResult。嵌套字段见共享类型。