权限系统API接口清单 - 应用身份服务

1、概述

本文档为IDaaS对外提供的权限相关的API文档，开发者可根据该文档进行集成IDaaS权限功能，进而实现系统权限数据的管控。

接口文档分类三大类：第一类，角色和权限管理接口，开发者可将业务系统中的角色和权限资源等通过RestFul API定义到IDaaS当中，第二类，授权管理接口，开发者可通过API对系统中的“人员”，“角色”之间进行授权的关联操作，第三类，开发者可通过API，在用户登录业务系统或操作业务系统中功能的时候对该“人员”进行一个鉴权的操作。

2、接口清单

权限系统全局接口

获取权限系统授权 access_token
获取权限系统信息

角色管理接口

获取权限系统的所有角色（分页）
新增角色
编辑角色
删除角色
新增权限
编辑权限
删除权限

授权管理接口

获取指定角色的已关联权限（分页）
把人授权到角色
把权限关联到角色
获取指定权限节点下，用户已授权的权限
获取角色所有已授权用户（分页）
获取权限系统指定用户的角色和权限

鉴权接口

判断用户是否有角色
根据权限uuid判断用户是否有权限
根据权限值判断用户是否有权限

获取权限系统授权 access_token

接口地址

POST http://your-idaas-domain/oauth/token

接口说明

所有的权限系统相关的接口，都是受保护的资源。只有通过本接口获取到 access_token，才能继续调用后续接口。

access_token 的使用方式有两种：

1. 第一种

Header参数传递

头名称为 Authorization，值为bearer {access_token} （请注意bearer和access_token之间的空格）

2. 第二种

Query参数传递

在请求URL的最后添加参数。如： http://your-idaas-domain/?access_token={access_token}

请求参数

参数	类型	必须	示例值	描述
client_id	string	是	78d8be99ef30197c31888f5d2d1390a6pHn71sZEqvP	从权限系统详情中获取到的 AppKey
client_secret	string	是	96csUmei1g0tL629ufrVMZviFie7NWBOnGYsJNLknQ	从权限系统详情中获取到的AppSecret
grant_type	array	是	固定值：client_credentials
Scope	string	是	固定值：read

返回参数

参数	类型	示例值	描述
access_token	string	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b	外部ID
token_type	string	bearer	OU uuid
expires_in	string	43199	access_token 过期时间，单位为秒。7200 秒为 2 小时。
scope	string	read	固定值：read

示例

请求示例

http://{{your-idaas-domain}}/oauth/token?
client_id=78d8be99ef30197c318885d2d1390a6pHn71sZEqvP
&client_secret=96csUmei1g0tL629ufrVMZviFie7NWBOnGYsJNLknQ
&grant_type=client_credentials&scope=read

正常返回示例

{   
    "access_token": "bd3a80ca-24c3-4da8-836f-9efcb2c52c4b",    
    "token_type": "bearer",    
    "expires_in": 41177,    
    "scope": "read"
}

参数和header请求示例

获取权限系统信息

接口地址

POST /api/bff/v1.2/developer/ps/details

接口说明

获取权限系统的基本信息。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
psId	String	是	Fgh9sKSS	系统id，详情处可见

返回参数

参数	类型	示例值	描述
uuid	string	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b	外部ID
createTime	string	2019-09-14 13:54	权限系统创建时间
archived	Boolean	False	逻辑删除，false代表正常，true代表已删除
psId	sting	Fgh9sKSS	PS系统唯一id
name	string	接口测试系统	权限系统名称
host	string	http://your-dmain.com	PS业务系统主页地址
remark	string	这是一个针对 BPM 应用的权限系统。	权限系统说明
creator	string	admin	权限系统创建人
enabled	boolean	true	是否已启用

示例

请求示例

{{your-idaas-domain}}/api/bff/v1.2/developer/ps/details?access_token={{access_token}}

请求入参示例

{
  "psId":"Fgh9sKSS"
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "47B0A008-778F-4BB9-801E-5D7C18FFE0EE",
    "data": {
        "uuid": "6e10dd2b2a0c4b92c64b840ea869886b6pWWnalmjpZ",
        "createTime": "2020-03-31 10:44",
        "archived": false,
        "name": "接口测试系统",
        "psId": "Fgh9sKSS",
        "host": null,
        "remark": null,
        "creator": "admin",
        "enabled": true
    }
}

Postman请求示例

获取权限系统的所有角色（分页）

接口地址

GET /api/bff/v1.2/developer/ps/all_roles

接口说明

获取指定权限系统下的角色信息。

请求参数

参数>	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
currentPage	int	否	1	查询第几页的数据，从 1 开始
pageSize	int	否	10	每页查询多少条目，不填写默认10条
psId	String	是	hU2czV4pMR	PS系统id

返回参数

参数	类型	示例值	描述
List	Array		角色列表
uuid	string	4c9b9f14e82a5d4978d5ed229ec1ae4d6912xmCXA1l	OU uuid
name	string	测试角色	角色名，同一个权限系统内，角色名是唯一的，最长64字符，不能为空
permissionValue	string	test_role	角色的权限值
remark	string	admin	描述
enabled	boolean	true	是否已启用
currentPage	int	1	当前页数，从 1 开始
ps	string	hU2czV4pMR	PS系统id
totalSize	int	2	总角色数量
pageSize	int	10	一页包含的角色数量
perPageSize	int	10	当前请求时参数返回

示例

请求示例

{{your-idaas-domain}}api/bff/v1.2/developer/ps/all_roles?currentPage=1&access_token={{access_token}}&psId=hU2czV4pMR

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "D537580C-A5A2-4557-AEDD-3294DFB8ECE6",
    "data": {
        "list": [ 
           {
                "uuid": "4c9b9f14e82a5d4978d5ed229ec1ae4d6912xmCXA1l",
                "name": "Michael 测试角色",
                "permissionValue": "michael_test_role",
                "remark": "",
                "enabled": false
            },
            {
                "uuid": "61a779e3b2ac948d8768bb03801f99d9gRSYuTIStRH",
                "name": "Michael测试角色2",
                "permissionValue": "michael_test2",
                "remark": "",
                "enabled": true
            }
        ],
        "totalSize": 2,
        "currentPage": 1,
        "psId":"hU2czV4pMR"
        "pageSize": 10,
        "perPageSize": 10,
    }}

新增角色

接口地址

POST /api/bff/v1.2/developer/ps/role/create?access_token={{access_token}}

接口说明

向当前的权限系统中新增一个角色。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
name	string	是	测试角色	角色名，同一个权限系统内，角色名是唯一的，最长64字符，不能为空
permissionValue	string	是	test_role	角色的权限值，统一个权限系统内，角色的权限值是唯一的，最长64字符，只能包含字母数字和“-”或者“_”，不能为空
enabled	boolean	是	true	是否启用角色
psId	String	是	hU2czV4pMR	PS系统id
remark	string	否	这是一个测试使用的角色	角色描述信息，最长255字符，可以为空
clientToken	string	否	Kqji1upjakhjdihq3e	IDaaS 幂等机制字段，由调用方自动随机生成，标识一次请求操作。

返回参数

参数	类型	示例值	描述
roleUuid	String	447fed833d8739ecb1caf6f38af14e65tthuiDBac88	新生成的角色全局唯一标识

示例

请求示例

{{your-idaas-domain}}/api/bff/v1.2/developer/ps/role/create?access_token={{access_token}}

请求入参示例

{
    "name":"测试角色",
    "permissionValue":"test_role",
    "enabled":true,
    "remark":"这是一个测试使用的角色",
        "clientToken":"hyc11bzqcjdra4fg",
        "psId":"hU2czV4pMR"
}

正常返回示例

{
    "success":true,
    "code":"200",
    "message":null,
    "requestId":"51331044-A2FE-474A-BA0B-BF84599D8AEE",
    "data":{
        "roleUuid":"447fed833d8739ecb1caf6f38af14e65tthuiDBac88"
    }
}

编辑角色

接口地址

PUT /api/bff/v1.2/developer/ps/role/update?access_token={{access_token}}

接口说明

修改一个现有角色。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
uuid	String	是	447fed833d8739ecb1caf	待修改的角色全局唯一标识，角色外部id，必填
name	string	是	测试角色	角色名，同一个权限系统内，角色名是唯一的，最长64字符，如果为空则代表不修改
permissionValue	string	是	test_role	角色的权限值，统一个权限系统内，角色的权限值是唯一的，最长64字符，只能包含字母数字和“-”或者“_”，如果为空则代表不修改
enabled	boolean	是	true	是否启用角色
psId	String	是	hU2czV4pMR	PS系统id
remark	string	否	这是一个测试使用的角色	角色描述信息，最长255字符，可以为空
clientToken	string	否	Kqji1upjakhjdihq3e	IDaaS 幂等机制字段，由调用方自动随机生成，标识一次请求操作。

返回参数

无。

示例

请求示例

{{your-idaas-domain}}/api/bff/v1.2/developer/ps/role/update?access_token={{access_token}}

请求入参示例

{
    "name":"测试角色",
    "uuid":"447fed833d8739ecb1caf6f38af14e65tthuiDBac88",
    "permissionValue":"test_role",
    "enabled":true,
    "remark":"这是一个测试使用的角色",
        "clientToken":"hyc11bzqcjdra4fg",
        "psId":"hU2czV4pMR"
}

正常返回示例

{
    "success":true,
    "code":"200",
    "message":null,
    "requestId":"51331044-A2FE-474A-BA0B-BF84599D8AEE"
}

删除角色

接口地址

DELETE /api/bff/v1.2/developer/ps/role/delete/{uuid}?access_token={{access_token}}

接口说明

删除角色，仅能删除禁用的角色

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-8 36f-9efcb2c52c4b
uuid	String	是	447fed833d8739ecb1caf 6f38af14e65tthuiDBac88	待删除的角色全局唯一标识，角色外部id

参数

类型

必须

示例值

描述

access_token

string

是

bd3a80ca-24c3-4da8-8

36f-9efcb2c52c4b

uuid

String

是

447fed833d8739ecb1caf

6f38af14e65tthuiDBac88

待删除的角色全局唯一标识，角色外部id

返回参数

无。

示例

请求示例

{{your-idaas-domain}}/api/bff/v1.2/developer/ps/role/delete/{{roleUuid}}?access_token={{access_token}}

正常返回示例

{
    "success":true,
    "code":"200",
    "message":null,
    "requestId":"51331044-A2FE-474A-BA0B-BF84599D8AEE",
    "data": null
}

新增权限

接口地址

POST /api/bff/v1.2/developer/ps/permission/create

接口说明

向当前的权限系统中新增一个权限。

IDaaS 权限系统可以维持一个属性接口，所以可以通过 parentUuid 参数指定父级权限。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4d a8-836f-9efcb2c52c4b
name	string	是	测试权限	权限名,最长64字符，不可为空
permissionValue	string	是	demo_permission	权限的权限值，同一个权限系统内唯一，最长64个字符，不可为空
type	String	是	menu	menu 或者 button，代表菜单类权限或按钮型权限，data 代表是数据类型
psId	String	是	hU2czV4pMR	PS系统id
parentUuid	String	否	9b63a96ee5aa800641b5a4	父级权限全局唯一标识，资源外部id，可以为null或者空字符串，null或者空字符串代表顶级的权限
remark	string	否	这是一个测试使用的权限	权限描述信息，可以为空，最长255字符
clientToken	string	否	Kqji1upjakhjdihq3e	IDaaS 幂等机制字段，由调用方自动随机生成，标识一次请求操作。

返回参数

参数	类型	示例值	描述
permissionUuid	string	7dabd9e92a175781072c265aeccfc0f6nmYAtFqciZ8	新生成的全局唯一标识

示例

请求示例

{{your-idaas-domain}}/api/bff/v1.2/developer/ps/permission/create?access_token={{access_token}}

请求入参示例

{
    "type":"menu",
    "permissionValue":"demo_permission",
    "name":"测试权限",
    "remark":"这是一个测试使用的权限",
    "psId":"mkcwicd4pqfhyd73"
}

正常返回示例

{
    "success":true,
    "code":"200",
    "message":null,
    "requestId":"51331044-A2FE-474A-BA0B-BF84599D8AEE"，    
        "data": {
        "permissionUuid": "7dabd9e92a175781072c265aeccfc0f6nmYAtFqciZ8"    
        }
}

编辑权限

接口地址

PUT /api/bff/v1.2/developer/ps/permission/update?access_token={{access_token}}

接口说明

向当前的权限系统中编辑一个角色。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
uuid	string	是	9b63a96ee5aa800641b5a4a	待编辑的权限全局唯一标识，资源外部id
name	string	否	测试权限	权限名,最长64字符,为空代表不修改
permissionValue	string	否	demo_permission	权限的权限值，同一个权限系统内唯一，最长64个字符，为空代表不修改
remark	string	否	这是一个测试使用的权限	权限描述信息
parentUuid	string	否	9b63a96ee5aa800641b5a4a	父级权限全局唯一标识，资源外部id，为 null 代表不修改，为空字符传代表修改为顶级节点
clientToken	string	否	Kqji1upjakhjdihq3e	IDaaS 幂等机制字段，由调用方自动随机生成，标识一次请求操作。

返回参数

无。

示例

请求示例

{{your-idaas-domain}} /api/bff/v1.2/developer/ps/permission/update?access_token={{access_token}}

请求入参示例

{
    "type":"menu",
    "permissionValue":"demo_permission",
    "name":"测试权限",
    "remark":"这是一个测试使用的权限",
        "clientToken":"mkcwicd4pqfhyd73",
        "psId":"hU2czV4pMR"
}

正常返回示例

{
    "success":true,
    "code":"200",
    "message":null,
    "requestId":"51331044-A2FE-474A-BA0B-BF84599D8AEE"
    "data": null
}

删除权限

接口地址

DELETE /api/bff/v1.2/developer/ps/permission/delete/{uuid}?access_token={{access_token}}

接口说明

删除一个现有权限。注意，当拥有子权限时，不可直接删除。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8 -836f-9efcb2c52c4b
uuid	String	是	447fed833d8739ecb1ca f6f38af14e65tthuiDBac88	待删除的角色全局唯一标识，资源外部id

参数

类型

必须

示例值

描述

access_token

string

是

bd3a80ca-24c3-4da8

-836f-9efcb2c52c4b

uuid

String

是

447fed833d8739ecb1ca

f6f38af14e65tthuiDBac88

待删除的角色全局唯一标识，资源外部id

返回参数

无。

示例

请求示例

{{your-idaas-domain}}/api/bff/v1.2/developer/ps/permission/delete/{{permissionUuid}}?access_token={{access_token}

正常返回示例

{
    "success":true,
    "code":"200",
    "message":null,
    "requestId":"51331044-A2FE-474A-BA0B-BF84599D8AEE"
    "data": null
}

获取指定角色的已关联权限（分页）

接口地址

POST /api/bff/v1.2/developer/ps/role_permissions

接口说明

获取指定角色的所有已关联权限。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
roleUuid	String	否	447fed833d8739ecb1c af6f38af14e65tthuiDBac88	指定角色全局唯一标识，角色外部id
currentPage	int	否	1	当前返回页数，从 1 开始
pageSize	int	否	10	每页数量
psId	Stirng	是	KSJDJSKkk	系统id,详情处可见

返回参数

参数	类型	示例值	描述
List	Array		角色列表
uuid	string	4c9b9f14e82a5d4978d5ed22 9ec1ae4d6912xmCXA1l	权限 uuid
parentPermissionUuid	String	978d5ed229ec1ae4d6912xmC XA1l4c9b9f14e82a5d4	父级权限的 uui
name	string	测试权限	权限名,最长64字符，不可为空
permissionValue	string	test_permission	权限的权限值
relationUrl	string		暂无使用
remark	string	这是一个新的测试权限。	描述
type	boolean	menu	是否已启用
dataAccessRules	string		暂无使用
perPageSize	string	shanghonglin	创建人
currentPage	int	1	当前页数，从 1 开始
totalSize	int	2	总角色数量
pageSize	int	10	一页包含的角色数量

示例

请求示例

{{your-idaas-domain}}}/api/bff/v1.2/developer/ps/role_permissions?access_token={{access_token}}

请求入参示例

{
    "roleUuid":"447fed833d8739ecb1caf6f38af14e65tthuiDBac88",
    "pageSize":"2",
     "psId":"hU2czV4pMR",
       "currentPage":"1"                
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "D537580C-A5A2-4557-AEDD-3294DFB8ECE6",
    "data": {
        "list": [
            {
                "uuid": "65f9e06df1a1cb04133845fd47e35196WUjqj9nkA1P",
                "parentPermissionUuid": null,
                "name": "打印—户籍卡",
                "permissionValue": "print_card",
                "remark": null,
                "type": "menu",
            },
            {
                "uuid": "540cf6e8b05b09b3938f865b33ab30d1GsMhz5NkVTq",
                "parentPermissionUuid": "65f9e06df1a1cb04133845fd47e35196WUjqj9nkA1P",
                "name": "本地的",
                "permissionValue": "local",
                "remark": null,
                "type": "menu",
            }
        ],
        "totalSize": 2,
        "currentPage": 1,
        "pageSize": 10,
               "perPageSize": 10,
    }
}

把人授权到角色

接口地址

POST /api/bff/v1.2/developer/ps/role/modify_users?access_token={{access_token}}

接口说明

新增或者取消人和角色之间的授权关系

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
roleUuid	String	是	447fed833d8739e cb1caf6f38af1	指定角色全局唯一标识，角色外部id
attachedUDAccount UuidCollection	Array	否	["09b00e257ede 0a38a5f54a94"]	想要增加授权到该角色的账号全局唯一标识数组
detachedUDAccountUuidCollection	Array	否	["09b00e257ede0a38a5f54a94"]	想要取消授权该角色的账号全局唯一标识数组
attachedUsernameCollection	Array	否	["zhang_san"]	想要增加授权到该角色的账号识数组
detachedUsernameCollection	Array	否	["li_si"]	想要取消授权该角色的账号数组

返回参数

无。

示例

请求示例

{{your-idaas-domain}} /api/bff/v1.2/developer/ps/role/modify_users?access_token={{access_token}}

请求入参示例

{
     "attachedUDAccountUuidCollection":["09b00e257ede0a38a5f54a94c4d64000EwQtyG8nUWw"],
     "detachedUDAccountUuidCollection":["90d99090309433adeaf4a94c4d64000EwQtyG8nUWw"],
     "attachedUsernameCollection":["zhang_san","li_si",
     "detachedUsernameCollection":["wang_wu","zhao_liu"],
     "roleUuid":"447fed833d8739ecb1caf6f38af14e65tthuiDBac88"
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "D537580C-A5A2-4557-AEDD-3294DFB8ECE6"
       "data": null
}

把权限关联到角色

接口地址

POST api/bff/v1.2/developer/ps/role/modify_permissions?access_token={{access_token}}

接口说明

建立权限和角色之间的关联关系。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
roleUuid	String	是	447fed833d8739ecb1 caf6f38af1	指定角色全局唯一标识，角色外部id
attachedPermissionUuid Collection	Array	否	["tyG8nUWw"]	想要新增权限全局唯一标识数组，资源外部id
detachedPermissionUuid Collection	Array	否	["tyG8nUWw"]	想要取消权限全局唯一标识数组，资源外部id

返回参数

无。

示例

请求示例

{{your-idaas-domain}} api/bff/v1.2/developer/ps/role/modify_permissions?access_token={{access_token}}

请求入参示例

{
    "roleUuid":"447fed833d8739ecb1caf6f38af14e65tthuiDBac88",
    "attachedPermissionUuidCollection":["65f9e06df1a1cb04133845fd47e35196WUjqj9nkA1P","540cf6e8b05b09b3938f865b33ab30d1GsMhz5NkVTq"],
    "detachedPermissionUuidCollection":["12f9e06df1a1cb04166666fd47e35196WUjqj9nkAee","340cf6e8b05b09b397890qeb33ab30d1GsMhz5NkVar"]
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "D537580C-A5A2-4557-AEDD-3294DFB8ECE6"
       "data": null
}

获取指定权限节点下，用户已授权的权限

接口地址

POST /api/bff/v1.2/developer/ps/listSubLevelPermissions

接口说明

获取一个指定权限节点下，一个用户的所有已授权的权限。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
username	string	是	michael	指定用户的账户名
permissionValue	String	否	print_card	指定父级权限节点的权限值
psId	String	是	SAFKJkljL	系统详情处可见
type	String	否	ALL,button,menu	权限类型

返回参数

参数	类型	示例值	描述
permissions	Array		角色列表
uuid	string	4c9b9f14e82a5d4978d5ed229ec 1ae4d6912xmCXA1l	权限 uuid
parentPermissionUuid	String	978d5ed229ec1ae4d6912xmC XA1l4c9b9f14e82a5d4	父级权限的 uuid
name	string	测试权限	权限名,最长64字符，不可为空
permissionValue	string	test_permission	权限的权限值
remark	string	这是一个测试权限。	权限说明
type	string	button	权限类型，菜单/按钮
dataAccessRules	string		暂无使用
relationUrl	stirng	http://your-domain.com	业务系统主页地址
displayOrder	long	0	资源排序号，整数，用于排序使用，数字越小越靠前展示
children	Array	当前资源的子级资源	当前资源的直属子级资源列表

示例

请求示例

{{your-idaas-domain}}}/api/bff/v1.2/developer/ps/listSubLevelPermissions?access_token={{access_token}}

请求入参示例

{
  
      "username":"michael",
      "permissionValue":"print_card",
      "psId":"hU2czV4pMR"
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "D537580C-A5A2-4557-AEDD-3294DFB8ECE6",
    "data": {
        "permissions": [
            {
                "uuid": "65f9e06df1a1cb04133845fd47e35196WUjqj9nkA1P",
                "parentPermissionUuid": null,
                "name": "打印—户籍卡",
                "permissionValue": "print_card",
                "remark": null,
                "type": "menu",
            },
            {
                "uuid": "540cf6e8b05b09b3938f865b33ab30d1GsMhz5NkVTq",
                "parentPermissionUuid": "65f9e06df1a1cb04133845fd47e35196WUjqj9nkA1P",
                "name": "本地的",
                "permissionValue": "local",
                "remark": null,
                "type": "menu",
            }
        ]
    }
}

获取角色所有已授权用户（分页）

接口地址

POST /api/bff/v1.2/developer/ps/role_users

接口说明

获取角色所有已授权用户。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
roleUuid	String	否	447fed833d8739ecb1caf6f38af14e65tthuiDBac88	指定角色全局唯一标识，角色外部id
currentPage	int	否	1	当前返回页数，从 1 开始
pageSize	int	否	10	每页数量
psId	String	是	SAFJASJk	系统id,详情处可见

返回参数

参数	类型	示例值	描述
list	Array		角色列表
udAccountUuid	String	978d5ed229ec1ae4d6912xmCX A1l4c9b9f14e82a5d4	IDaaS 系统内 UDAccount 的全局唯一标识
username	string	michael	用户名
displayName	string	Michael Dis	显示名称
perPageSize	int	10	每一页显示的用户数
totalSize	int	2	角色授权的用户数
psId	string	XuJNOLtDam	系统id,详情处可见
roleUuid	string	b661f136fbde1c895b44eda7111ab458s736vCvD8aB	IDaaS 系统内角色的全局唯一标识
currentPage	int	1	查询第几页的数据，从 1 开始
pageSize	int	10	每一页显示的用户数

示例

请求示例

{{your-idaas-domain}}}/api/bff/v1.2/developer/ps/role_users?access_token={{access_token}}

请求入参示例

{
      "roleUuid":"447fed833d8739ecb1caf6f38af14e65tthuiDBac88",
      "psId":"SAFJASJk",
      "currentPage":"1",
      "pageSize":"10",
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "D537580C-A5A2-4557-AEDD-3294DFB8ECE6",
    "data": {
        "list": [
            {
                "udAccountUuid": "09b00e257ede0a38a5f54a94c4d64000EwQtyG8nUWw",
                "username": "fufu033",
                "displayName": "付付023",
            },
            {
                "udAccountUuid": "dab27222a6cd330ff25dc4b6c4a21dcarH8a17zqk3z",
                "username": "michael",
                "displayName": "Michael_updated",
            }
        ],
               "psid":"XuJNOLtDam",
               "roleUuid":"b661f136fbde1c895b44eda7111ab458s736vCvD8aB"
        "totalSize": 2,
        "currentPage": 1,
        "perPageSize": 10,
               "pageSize": 10
    }
}

获取权限系统指定用户的角色和权限

接口地址

POST /api/bff/v1.2/developer/ps/user_role_permissions

接口说明

获取用户已授权的角色和权限。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
username	String	是	Zhangsan	指定的用户名
psId	String	是	SAFJASJk	系统id,详情处可见

返回参数

参数	类型	示例值	描述
username	string	Zhangsan	指定的用户名
rolePermissions	Array		用户拥有的角色及权限集合
uuid	string		IDaaS系统内角色的全局唯一标识
name	string		IDaaS系统内角色的
permissionValue	string		IDaaS系统内角色的权限值
remark	string		IDaaS系统内角色的描述
enabled	boolean		IDaaS系统内角色的状态，true为启用，
permissions	Array		角色拥有的权限列表
uuid	string	978d5ed229ec1ae4d6912xmCX A1l4c9b9f14e82a5d4	IDaaS 系统内权限的全局唯一标识
name	string	Add用户	权限relationUrl
remark	string	Add user test	备注
permissionValue	string	ADD	权限值
type	string	Menu	类型，menu，button等
dataAccessRules	string		暂无使用
permission	Array		账户拥有的所有权限列表
uuid	string	978d5ed229ec1ae4d6912xmCX A1l4c9b9f14e82a5d4	IDaaS 系统内权限的全局唯一标识
name	string	Add用户	权限名称
relationUrl	string		暂无使用
remark	string	Add user test	备注
permissionValue	string	ADD	权限值
type	string	Menu	类型，menu，button等
dataAccessRules	string		暂无使用
roles	Array		角色列表，暂时不返回参数

示例

请求示例

{{your-idaas-domain}}}/api/bff/v1.2/developer/ps/user_role_permissions?access_token={{access_token}}

请求入参示例

{
      "psId":"SAFJASJk",
      "username":"michael"
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "BC8EF781-56CA-4EA4-95FB-BE19A9832A84",
    "data": {
        "username": "test007",
        "rolePermissions": [
            {
                "uuid": "58e146dd8def3b9052411ba408bf8a5bDnUgQBO7md2",
                "name": "审计管理员",
                "permissionValue": "audit_admin",
                "remark": "权限接口创建的角色",
                "enabled": true,
                "permissions": [
                    {
                        "uuid": "67af927c55941dd4742a3019ff3a9641hqRqvIdzuIG",
                        "parentPermissionUuid": null,
                        "name": "审计",
                        "permissionValue": "audit",
                        "relationUrl": null,
                        "remark": "通过接口创建权限资源",
                        "type": "menu",
                        "dataAccessRules": []
                    }
               ]
         }]
        "permissions": [
                    {
                        "uuid": "67af927c55941dd4742a3019ff3a9641hqRqvIdzuIG",
                        "parentPermissionUuid": null,
                        "name": "审计",
                        "permissionValue": "audit",
                        "relationUrl": null,
                        "remark": "通过接口创建权限资源",
                        "type": "menu",
                        "dataAccessRules": []
                    }
               ]
        "roles": [        
        ]
    }
}

判断用户是否有角色

接口地址

POST /api/bff/v1.2/developer/ps/has_role

接口说明

判断用户是否拥有某角色。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
roleUuid	String	是	540cf6e8b05b09b393 8f865b33ab30d1	指定角色全局唯一标识，角色外部id
username	String	是	michael	指定账号的账户名
psId	String	是	SAFJASJk	系统id，详情处可见

返回参数

无

示例

请求示例

{{your-idaas-domain}}}/api/bff/v1.2/developer/ps/has_role?access_token={{access_token}}

请求入参示例

{
    "roleUuid": "540cf6e8b05b09b3938f865b33ab30d1GsMhz5NkVTq",
     "psId":"SAFJASJk",
     "username": "michael"
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "76C29BF5-3236-4C17-9C0D-92834AC12B73",
    "data": false
}

根据权限uuid判断用户是否有权限

接口地址

POST /api/bff/v1.2/developer/ps/has_permission

接口说明

判断用户是否拥有某权限。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
permissionUuid	String	是	447fed833d8739ecb1caf6f38af14e65tthuiDBac88	指定权限全局唯一标识，资源外部id
username	String	是	michael	指定账号的账户名
psId	String	是	ASFjasds	系统id，系统详情处可见

返回参数

参数	类型	必须	示例值	描述
hasPermission	Boolean	是	false	是否已有授权关系

根据权限值判断用户是否有权限

接口地址

POST /api/bff/v1.2/developer/ps/isUserHasPermission

接口说明

通过权限值来判断用户是否拥有某权限/角色。

请求参数

参数	类型	必须	示例值	描述
access_token	string	是	bd3a80ca-24c3-4da8-836f-9efcb2c52c4b
permissionValue	String	是	test_permission	指定权限的权限值
username	String	是	09b00e257ede0a38a5f54a94c4d 64000EwQtyG8nUWw	指定账号的用户名
psId	String	是	KDJDJSSKK	系统id，详情处可见

返回参数

参数	类型	必须	示例值	描述
hasPermission	Boolean	是	false	是否已有授权关系

示例

请求示例

{{your-idaas-domain}}}/api/bff/v1.2/developer/ps/isUserHasPermission?access_token={{access_token}}

请求入参示例

{
    "permissionValue": "print_card",
     "psId":"KDJDJSSKK",
    "username": "michael"
}

正常返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "76C29BF5-3236-4C17-9C0D-92834AC12B73",
    "data": {
        "hasPermission":false
    }
}

FAQ

1. 下图中的Account uuid如何获取

按F12打开控制台，访问账户的详情，查看uuid

建议使用username字段，直接对应账户名称。