获取应用授权的用户列表

接口描述:

第三方平台可通该接口实时获取最新的当前应用在应用市场已经被授权访问的用户列表,通过该接口可做一些用户相关的权限控制实现。

接口地址:

请求方式:

  • GET

请求头:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
X-App-Id 客户端 clientId header true string

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
accessToken 接口访问凭证 query true string
lastSequence 上一次去数据后台返回给客户的Seq,默认为0 query false integer(int64)
limit 期望获取的数据量,0 < limit <= 1000,默认为1000 query false integer(int64)

响应状态

状态码 说明 schema
200 OK ApiRestResponse«List«AppUserVO»»

其他状态码参见:全局状态码

响应示例:

正确时返回:

{
    "code": 200,
    "status": "success",
    "message": "请求成功",
    "data": [
        {
            "userId": 0,
            "account": "",
            "email": "",
            "gender": 0,
            "nickname": "",
            "thirdAccount": "",
            "thirdUserId": 0,
            "thirdUserName": "",
            "roleList": [
                {
                    "orgId": 0,
                    "roleCode": "",
                    "roleId": 0,
                    "roleName": "",
                    "userId": 0
                }
            ],
            "lastSequence": 0
        }
    ]
}

错误时返回:

{
    "code": 500,
    "data": {},
    "message": "成功或异常消息",
    "status": "fail"
}

响应参数:

参数名称 参数说明 类型 schema
code 成功或异常编码 integer(int32) integer(int32)
data 成功或异常数据 array AppVO
message 成功或异常消息 string
status 旧接口成功、失败或异常辅助判断标记:success、fail、error,可用值:success,fail,error string
Schema 属性:

AppUserVO

参数名称 参数说明 类型 schema
userId 用户id integer(int64)
account 登录账户 string
email 电子邮箱 string
gender 性别:(1:男,2:女) integer(int32)
nickname 用户别名(昵称) string
roleList 用户在该学校/组织机构下拥有的角色 array UserOrgRoleVO
thirdAccount 绑定的三方账号 string
thirdUserId 绑定的三方用户Id integer(int64)
thirdUserName 绑定的三方用户名称 string
lastSequence 上一次去数据后台返回给客户的Seq,初次拉取时为0 integer(int64)

UserOrgRoleVO

参数名称 参数说明 类型 schema
orgId 角色授权机构ID integer(int64)
roleCode 角色编码 string
roleId 角色ID integer(int64)
roleName 角色名称 string

调用示例:

NodeJs - Axios:

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api_server_url/app/user/list?accessToken=AT-3-ewOumlQeTN7TmVufJxq-Ph1fNVnqUTeW',
  headers: {
    'X-App-Id': '1'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Java - OkHttp 示例:

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://api_server_url/app/user/list?accessToken=AT-3-ewOumlQeTN7TmVufJxq-Ph1fNVnqUTeW")
  .method("GET", body)
  .addHeader("X-App-Id", "1")
  .build();
Response response = client.newCall(request).execute();
作者:杭州天音  创建时间:2022-10-26 16:28
最后编辑:杭州天音  更新时间:2025-08-22 15:44