应用角色
获取角色列表
根据鉴权方式查看“获取角色列表”对应的真实 API 地址、参数与响应。
鉴权方式
AppKey + Sign 是应用密钥鉴权,由管理员创建,用于以应用管理员身份访问应用数据。
版本
请求地址
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
HAP-Appkey | string | 是 | HAP应用密钥 |
HAP-Sign | string | 是 | HAP签名 |
响应参数
200成功获取角色列表| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 是否调用成功 |
error_code | integer | 错误代码 |
error_msg | string | 错误消息 |
data | object | 角色列表查询结果 |
data.roles | object[] | 角色列表 |
data.roles.id | string | 角色Id |
data.roles.name | string | 角色名称 |
data.roles.roleType | string | 角色类型 |
data.roles.description | string | 角色描述 |
data.roles.accounts | object[] | 用户列表 |
data.roles.accounts.id | string | 人员 id |
data.roles.accounts.name | string | 名称 |
data.roles.accounts.avatar | string | 头像地址 |
data.roles.accounts.isPortal | boolean | 是否为门户用户 |
data.roles.accounts.status | integer | 状态 |
data.roles.accounts.accountId | string | 人员 id (兼容字段) |
data.roles.accounts.fullname | string | 名称 (兼容字段) |
data.roles.departmentTrees | object[] | 部门树列表 |
data.roles.departmentTrees.id | string | 部门 id |
data.roles.departmentTrees.name | string | 部门名称 |
data.roles.departments | object[] | 部门列表 |
data.roles.departments.id | string | 部门 id |
data.roles.departments.name | string | 部门名称 |
data.roles.jobs | object[] | 职位列表 |
data.roles.jobs.id | string | 职位 id |
data.roles.jobs.name | string | 职位名称 |
data.roles.orgRoleIds | string[] | 组织角色ID列表 |
curl -X GET "https://example.com/v3/app/roles" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}"{ "data": { "roles": [ { "id": "角色Id", "name": "角色名称", "roleType": "角色类型", "description": "角色描述", "accounts": [ { "accountId": "账号Id", "fullname": "用户名", "avatar": "用户头像链接" } ], "departments": [ { "id": "部门Id", "name": "部门名称" } ], "jobs": [ { "id": "职位Id", "name": "职位名称" } ], "orgRoleIds": [ "组织角色ID" ] } ] }, "success": true}