目录搜索

暂无相关搜索结果！

本文档使用 MinDoc 发布

第三方授权管理

审核第三方授权
批量审核第三方授权
查询第三方授权
【第三方授权】列表(分页条件查询)数据
【第三方授权】选择器列表(分页条件查询)数据
删除(批量)
密钥重置
保存第三方授权
备注

审核第三方授权

简述：

审核第三方授权

请求URL：

http://ip:port/ibps/platform/v3/auth/client/audit
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

AuthClientPo 对象信息

名称	类型	是否必须	备注
id	String	否	主键
clientKey	String	是	第三方标识
clientSecret	String	是	密钥
clientName	String	是	第三方名称
clientUri	String	是	第三方Domain
clientDesc	String	否	描述
scope	String	是	作用域：sso/api
grantTypes	String	是	授权类型：code/password/…
status	String	是	状态:pendding/effect/expire
createBy	String	否	创建人
createTime	Date	否	申请时间
expireTime	Date	是	过期时间
auditBy	String	否	审核人
auditTime	Date	否	审核时间
cause	String	否	理由
creator	String	否	创建人
auditor	String	否	审核人

请求参数示例：

{
    "pk": "",
    "name": null,
    "ip": null,
    "createBy": "654384477392338944",
    "createTime": "2020-02-04 14:56:12",
    "updateBy": null,
    "updateTime": null,
    "tenantId": null,
    "dataStatus": null,
    "dbtype": null,
    "id": "674266967913267200",
    "clientKey": "test",
    "clientSecret": "a39d1c3d-f68c-44c2-9889-1537f3688adf",
    "clientName": "test",
    "clientUri": "test",
    "clientDesc": "",
    "scope": "sso",
    "grantTypes": "code",
    "status": "pendding",
    "expireTime": "2021-02-04",
    "auditBy": null,
    "auditTime": null,
    "cause": null,
    "creator": "tom",
    "auditor": null
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "审核第三方授权成功",
    "cause": "",
    "variables": {
        "id": "674266967913267200"
    },
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

批量审核第三方授权

简述：

批量审核第三方授权

请求URL：

http://ip:port/ibps/platform/v3/auth/client/audit/batch
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注
authClientIds	String[]	是		第三方授权id数组
cause	String	否	审核不通过	不通过原因
expireTime	String	否		过期日期,例如2019-11-11
nopass	String	否		不通过标识

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/auth/client/audit/batch?authClientIds=674271909910675456&cause=审核不通过&expireTime=&nopass=

返回示例：

{
    "state": 200,
    "request": null,
    "message": "审核第三方授权成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

查询第三方授权

简述：

查询第三方授权

请求URL：

http://ip:port/ibps/platform/v3/auth/client/get
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
authClientId	String	是		第三方授权id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/auth/client/get?authClientId=674271909910675456

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": "654384477392338944",
        "createTime": "2020-02-04 15:15:51",
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "674271909910675456",
        "clientKey": "test1",
        "clientSecret": "277ed11d-b442-4259-8277-836d7cec46c4",
        "clientName": "test1",
        "clientUri": "test1",
        "clientDesc": "",
        "scope": "sso",
        "grantTypes": "code",
        "status": "effect",
        "expireTime": "2021-02-04",
        "auditBy": "654384477392338944",
        "auditTime": "2020-02-04 15:16:24",
        "cause": "审核通过！",
        "creator": "tom",
        "auditor": "tom"
    }
}

返回参数说明：

名称	类型	备注
data	AuthClientPo	第三方授权对象

【第三方授权】列表(分页条件查询)数据

简述：

【第三方授权】列表(分页条件查询)数据

请求URL：

http://ip:port/ibps/platform/v3/auth/client/query
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
request	APIRequest^[1]	是		动态查询请求对象

请求参数示例：

{
    "parameters": [],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": "654384477392338944",
                "createTime": "2020-02-04 15:15:51",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "674271909910675456",
                "clientKey": "test1",
                "clientSecret": "277ed11d-b442-4259-8277-836d7cec46c4",
                "clientName": "test1",
                "clientUri": "test1",
                "clientDesc": "",
                "scope": "sso",
                "grantTypes": "code",
                "status": "effect",
                "expireTime": "2021-02-04",
                "auditBy": "654384477392338944",
                "auditTime": "2020-02-04 15:16:24",
                "cause": "审核通过！",
                "creator": "tom",
                "auditor": "tom"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": "654384477392338944",
                "createTime": "2020-02-04 15:13:54",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "674271418459881472",
                "clientKey": "test3",
                "clientSecret": "da035d4f-b719-4c1e-9a95-b3a96d488c11",
                "clientName": "test3",
                "clientUri": "test3",
                "clientDesc": "",
                "scope": "sso",
                "grantTypes": "code",
                "status": "effect",
                "expireTime": "2021-02-04",
                "auditBy": "654384477392338944",
                "auditTime": "2020-02-04 15:14:01",
                "cause": "审核通过！",
                "creator": "tom",
                "auditor": "tom"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": "654384477392338944",
                "createTime": "2020-02-04 15:13:44",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "674271379796787200",
                "clientKey": "test2",
                "clientSecret": "27932b0a-6028-45a1-8429-7d9d9fa84bea",
                "clientName": "test2",
                "clientUri": "test2",
                "clientDesc": "",
                "scope": "sso",
                "grantTypes": "code",
                "status": "effect",
                "expireTime": "2021-02-04",
                "auditBy": "654384477392338944",
                "auditTime": "2020-02-04 15:14:01",
                "cause": "审核通过！",
                "creator": "tom",
                "auditor": "tom"
            }
        ],
        "pageResult": {
            "limit": 3,
            "page": 1,
            "totalCount": 12,
            "totalPages": 4
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< AuthClientPo >	第三方授权对象

【第三方授权】选择器列表(分页条件查询)数据

简述：

【第三方授权】选择器列表(分页条件查询)数据

请求URL：

http://ip:port/ibps/platform/v3/auth/client/query/selector
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
request	APIRequest^[1]	是		动态查询请求对象

请求参数示例：

{
    "parameters": [],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": "654384477392338944",
                "createTime": "2020-02-04 15:15:51",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "674271909910675456",
                "clientKey": "test1",
                "clientSecret": "277ed11d-b442-4259-8277-836d7cec46c4",
                "clientName": "test1",
                "clientUri": "test1",
                "clientDesc": "",
                "scope": "sso",
                "grantTypes": "code",
                "status": "effect",
                "expireTime": "2021-02-04",
                "auditBy": "654384477392338944",
                "auditTime": "2020-02-04 15:16:24",
                "cause": "审核通过！",
                "creator": "tom",
                "auditor": "tom"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": "654384477392338944",
                "createTime": "2020-02-04 15:13:54",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "674271418459881472",
                "clientKey": "test3",
                "clientSecret": "da035d4f-b719-4c1e-9a95-b3a96d488c11",
                "clientName": "test3",
                "clientUri": "test3",
                "clientDesc": "",
                "scope": "sso",
                "grantTypes": "code",
                "status": "effect",
                "expireTime": "2021-02-04",
                "auditBy": "654384477392338944",
                "auditTime": "2020-02-04 15:14:01",
                "cause": "审核通过！",
                "creator": "tom",
                "auditor": "tom"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": "654384477392338944",
                "createTime": "2020-02-04 15:13:44",
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "674271379796787200",
                "clientKey": "test2",
                "clientSecret": "27932b0a-6028-45a1-8429-7d9d9fa84bea",
                "clientName": "test2",
                "clientUri": "test2",
                "clientDesc": "",
                "scope": "sso",
                "grantTypes": "code",
                "status": "effect",
                "expireTime": "2021-02-04",
                "auditBy": "654384477392338944",
                "auditTime": "2020-02-04 15:14:01",
                "cause": "审核通过！",
                "creator": "tom",
                "auditor": "tom"
            }
        ],
        "pageResult": {
            "limit": 3,
            "page": 1,
            "totalCount": 12,
            "totalPages": 4
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< AuthClientPo >	第三方授权对象

删除(批量)

简述：

删除(批量)

请求URL：

http://ip:port/ibps/platform/v3/auth/client/remove
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
authClientIds	String[]	是		第三方授权id数组

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/auth/client/remove?authClientIds=674271418459881472

返回示例：

{
    "state": 200,
    "request": null,
    "message": "删除第三方授权成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

密钥重置

简述：

密钥重置

请求URL：

http://ip:port/ibps/platform/v3/auth/client/reset
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
authClientId	String	是		第三方授权id
clientSecret	String	是		授权密钥

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/auth/client/reset?authClientId=674271909910675456&clientSecret=277ed11d-b442-4259-8277-836d7cec46c4

返回示例：

{
    "state": 200,
    "request": null,
    "message": "密钥重置成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

保存第三方授权

简述：

保存第三方授权

请求URL：

http://ip:port/ibps/platform/v3/auth/client/save
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

AuthClientPo 对象信息

名称	类型	是否必须	备注
id	String	否	主键
clientKey	String	是	第三方标识
clientSecret	String	是	密钥
clientName	String	是	第三方名称
clientUri	String	是	第三方Domain
clientDesc	String	否	描述
scope	String	是	作用域：sso/api
grantTypes	String	是	授权类型：code/password/…
status	String	是	状态:pendding/effect/expire
createBy	String	否	创建人
createTime	Date	否	申请时间
expireTime	Date	是	过期时间
auditBy	String	否	审核人
auditTime	Date	否	审核时间
cause	String	否	理由
creator	String	否	创建人
auditor	String	否	审核人

请求参数示例：

{
    "clientKey": "tests",
    "clientName": "tests",
    "clientUri": "tests",
    "clientSecret": "cdfbe9ca-541d-48e0-a322-89096abacf70",
    "scope": "sso",
    "grantTypes": "code",
    "expireTime": "2021-02-04T07:13:30.679Z",
    "clientDesc": "",
    "status": "pendding",
    "createBy": "654384477392338944",
    "createTime": ""
}

返回示例：

{
  "state": 200,
  "request": null,
  "message": "保存第三方授权信息成功",
  "cause": "",
  "variables": {
    "id": "674277175821598720"
  },
  "data": null
}

返回参数说明：

名称	类型	备注
data	Void

备注

[1] : APIRequest为动态查询请求对象，详情请移步全局请求格式

文档更新时间: 2020-02-04 16:43 作者：朱业成