4.4.4.1 查询角色详情-基于id
可通过此接口在用户目录查询角色详情。
基本信息
请求地址:
https://SDPC-IP:4433/api/v3/role/queryById
请求方式:
GET
请求头(Header)
- 请求参数(Query)
参数 | 中文名称 | 必须 | 类型 | 描述 |
---|---|---|---|---|
directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识,在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local 。外部用户目录示例: custom01339 (唯一标识无需携带@) |
id | 角色id | 是 | string | 示例:2000dfe1-e4fe-11ee-bee9-fefcfeefe529 |
- 请求示例
curl --location --request GET 'https://SDPC-IP:4433/api/v3/role/queryById?directoryDomain=custom01339&id=2000dfe1-e4fe-11ee-bee9-fefcfeefe529' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--header 'Cookie: locale=zh-cn'
- 返回数据
参数 | 中文名称 | 类型 | 描述 |
---|---|---|---|
code | 响应码 | string | OK 表示成功,其他表示出错。具体含义请参考错误码定义 |
data | 响应数据 | object | |
├─ id | 角色id | string | 示例:2000dfe1-e4fe-11ee-bee9-fefcfeefe529 |
├─ name | 角色名 | string | 示例:role1 |
├─ externalId | 外部id | string | 示例:81dc9bdb52d04dc2 |
├─ description | 描述 | string | |
├─ userIdList | 关联用户 id 数组 | string[] | 示例: [ "765220d0-b9bf-11ee-84b3-17b16dc2b7bc" ] |
├─ groupIdList | 关联组织架构 id 数组 | string[] | 示例: [ "2ba49820-d4e1-11ec-9fe6-23abd5e79ce7", "b567fc10-b9a4-11ee-9574-3501cced60d3" ] |
├─ resourceIdList | 关联应用 id 数组 | string[] | 示例: [ "08975347-e68b-4c15-b4f3-93eb8fbfd101", "47fc233a-c620-4fd1-88e2-290f8918ccdd" ] |
├─ resourceGroupIdList | 关联应用分类 id 数组 | string[] | 示例: [ "cb818f04-2271-43ad-b103-0241d92597cc", "86ed36d9-833f-4167-8320-61a03afb09c9" ] |
msg | 描述信息 | string | |
traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {
"id": "e44ee930-f5e7-11ec-a438-5dafc0984f1e",
"name": "role1",
"description": "new desc of r11",
"externalId": "81dc9bdb52d04dc2",
"resourceIdList": [
"080541f0-d4ee-11ec-9fe6-23abd5e79ce7"
],
"resourceGroupIdList": [
"default"
],
"userIdList": [
"765220d0-b9bf-11ee-84b3-17b16dc2b7bc"
],
"groupIdList": [
"2ba49820-d4e1-11ec-9fe6-23abd5e79ce7",
"b567fc10-b9a4-11ee-9574-3501cced60d3"
]
},
"msg": "请求成功",
"traceId": "00e71b2bc002a77b"
}
错误码