角色对外API
角色对外api描述SID向应用提供的标准接口,以便外部应用调用。标准接口如下:
一、创建应用角色接口
当业务系统需要在SourceId创建应用角色时调用;角色创建之后,需要将该角色分配给用户,才能通过用户查询到角色
请求⽅式: POST(HTTPS或HTTP)
请求地址: http://self.xxx.edu.cn/linkid/public/api/aggregate/app/remote/role/create
注:https方式类似。
请求参数:
{
"roleName":"应用生成的角色名称",
"roleCode":"应用生成的角色编号",
"roleDescriber":"应用生成的角色的描述"
}
参数说明:
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
roleName | string | 是 | 应用生成的角色名称 |
roleCode | string | 是 | 应用生成的角色编号 |
roleDescriber | string | 否 | 应用生成的角色的描述 |
返回结果:
{
"code": 200,
"message": "OK",
"data": true
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回状态code |
message | String | 返回状态消息 |
data | boolean | 保存结果 |
二、查询应用生成的角色
查询应用系统关联的角色
请求⽅式: GET(HTTPS或HTTP)
请求地址: http://self.xxx.edu.cn/linkid/public/api/aggregate/app/remote/role/find
注:https方式类似。
请求参数:
请求示例:
https://ljw.sso.rghall.com.cn/linkid/public/api/aggregate/app/remote/role/find
返回结果:
{
"code": 200,
"message": "OK",
"data": [
{
"id": "应用角色ID",
"appId": "应用系统的ID",
"roleName": "应用角色名称",
"roleCode": "应用角色编号",
"roleDescriber": "应用角色描述"
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回状态code |
message | String | 返回状态消息 |
data | 自定义对象 | 返回值为应用角色信息列表 |
id | string | 应用角色ID |
appId | string | 应用系统的ID |
roleName | string | 应用角色名称 |
roleCode | string | 应用角色编号 |
roleDescriber | string | 应用角色描述 |
三、查询用户在某个应用匹配的应用角色
查询用户在某个应用匹配的应用角色
请求⽅式: GET(HTTPS或HTTP)
请求地址: http://self.xxx.edu.cn/linkid/public/api/aggregate/app/remote/role/find/user/{userId}
注:https方式类似。
请求参数:
示例:http://ljw.sso.rghall.com.cn/linkid/public/api/aggregate/app/remote/role/find/user/12345
参数说明:
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userId | string | 是 | 账号 |
返回结果:
{
"code": 200,
"message": "OK",
"data": [
{
"id": "应用角色ID",
"appId": "应用系统的ID",
"roleName": "应用角色名称",
"roleCode": "应用角色编号",
"roleDescriber": "应用角色描述"
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回状态code |
message | String | 返回状态消息 |
data | 自定义对象 | 返回值为应用角色信息列表 |
id | string | 应用角色ID |
appId | string | 应用系统的ID |
roleName | string | 应用角色名称 |
roleCode | string | 应用角色编号 |
roleDescriber | string | 应用角色描述 |
四、查询用户在所有应用匹配的应用角色
查询用户在所有应用匹配的应用角色
请求⽅式: GET(HTTPS或HTTP)
请求地址: http://self.xxx.edu.cn/linkid/api/aggregate/app/remote/public/role/find/user/{userId}
注:https方式类似。
请求参数:
示例: http://ljw.sso.rghall.com.cn/linkid/api/aggregate/app/remote/public/role/find/user/12345
参数说明:
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userId | string | 是 | 账号 |
返回结果:
{
"code": 200,
"message": "OK",
"data": [
{
"id": "应用角色ID",
"appId": "应用系统的ID",
"roleName": "应用角色名称",
"roleCode": "应用角色编号",
"roleDescriber": "应用角色描述"
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回状态code |
message | String | 返回状态消息 |
data | 自定义对象 | 返回值为应用角色信息列表 |
id | string | 应用角色ID |
appId | string | 应用系统的ID |
roleName | string | 应用角色名称 |
roleCode | string | 应用角色编号 |
roleDescriber | string | 应用角色描述 |
接口调用失败请查看开发指南-Token与Api调用失败须知