获取应用的授权角色列表
接口描述:
第三方平台可通该接口实时获取平台下放给应用的角色。
接口地址:
请求方式:
- GET
请求头:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
X-App-Id | 客户端 clientId | header | true | string |
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
accessToken | 接口访问凭证 | query | true | string |
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ApiRestResponse«List«AppRoleVO»» |
其他状态码参见:全局状态码
响应示例:
正确时返回:
{
"code": 200,
"status": "success",
"message": "请求成功",
"data": [
{
"roleCode": "",
"roleId": 0,
"roleName": ""
}
]
}
错误时返回:
{
"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 属性:
AppRoleVO
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
roleId | 角色ID | integer(int64) | |
roleCode | 角色编码 | string | |
roleName | 角色名称 | string |
@Data
public class AppRoleVO implements Serializable {
/**
* 角色ID
*/
@JsonSerialize(using = ToStringSerializer.class)
private Long roleId;
/**
* 角色编码
*/
private String roleCode;
/**
* 角色名称
*/
private String roleName;
@Override
public boolean equals(Object obj) {
if (obj instanceof AppRoleVO) {
AppRoleVO tmp = (AppRoleVO) obj;
if (this.getRoleId().equals(tmp.getRoleId())) {
return true;
}
}
return false;
}
}
调用示例:
NodeJs - Axios:
var axios = require('axios');
var config = {
method: 'get',
url: 'https://api_server_url/app/role/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/role/list?accessToken=AT-3-ewOumlQeTN7TmVufJxq-Ph1fNVnqUTeW")
.method("GET", body)
.addHeader("X-App-Id", "1")
.build();
Response response = client.newCall(request).execute();
作者:杭州天音 创建时间:2022-11-15 18:33
最后编辑:杭州天音 更新时间:2025-08-22 15:44
最后编辑:杭州天音 更新时间:2025-08-22 15:44