用户管理
用户操作使用目标应用的 appId。list 返回分页数据,search 返回选人列表。requireOriginId=true 只搜索具有业务侧用户标识的用户。setStatus 接受 active 或 disabled。
issueToken 通过控制台接口签发课堂用户凭证。应用凭证客户端的 client.auth.issueToken 则在本地使用应用密钥签名;两种入口返回的课堂凭证与控制台租户登录令牌用途不同。
应用后端使用应用业务接口和应用凭证。本页描述独立的租户管理调用。
users.list
用户列表。
GET /v1/users
鉴权:租户 Bearer Token 与 x-app-id。
| 语言 | 调用 |
|---|---|
| Node.js | c.users.list(appId, input) |
| Python | c.users.list(app_id, **input) |
| Java | c.users.list(appId, input) |
| Go | c.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.js | c.users.search(appId, input) |
| Python | c.users.search(app_id, **input) |
| Java | c.users.search(appId, input) |
| Go | c.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.js | c.users.create(appId, input) |
| Python | c.users.create(app_id, **input) |
| Java | c.users.create(appId, input) |
| Go | c.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.js | c.users.setStatus(appId, input) |
| Python | c.users.set_status(app_id, **input) |
| Java | c.users.setStatus(appId, input) |
| Go | c.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.js | c.users.issueToken(appId, input) |
| Python | c.users.issue_token(app_id, **input) |
| Java | c.users.issueToken(appId, input) |
| Go | c.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。嵌套字段见共享类型。