更新时间:2022-09-01 GMT+08:00
授权
功能介绍
APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
请求方法 |
URI |
---|---|
POST |
/v1.0/apigw/app-auths |
请求消息
名称 |
是否必选 |
类型 |
说明 |
---|---|---|---|
api_ids |
是 |
Array of strings |
API的编号列表 |
app_ids |
是 |
Array of strings |
APP的编号列表 |
env_id |
是 |
String |
需要授权的环境编号 |
请求参数样例:
{ "api_ids": ["5bbc47e2-95b0-4a56-904e-a3cdc422f8e9", "6632a062-9dcf-4f18-9646-3cabb925a290"], "app_ids": ["14b399ac-967f-4115-bb62-c0346b4537e9"], "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID" }
响应消息
名称 |
类型 |
说明 |
---|---|---|
-- |
字典数据类型 |
API与APP的授权关系列表 |
名称 |
类型 |
说明 |
---|---|---|
id |
String |
授权关系编号 |
api_id |
String |
API编号 |
app_id |
String |
APP编号 |
auth_time |
Timestamp |
授权时间 |
auth_role |
String |
授权者: PROVIDER:API提供者授权 CONSUMER:API消费者授权 |
auth_result |
String |
授权结果: SUCCESS:授权成功 SKIPPED:跳过 |
响应消息样例:
[{ "id": "dffcaff92d144135a9f420fcd485bbf3", "api_id": "8aa097b00e9843efabc9c593d11b769d", "app_id": "f8c6ea15-0d1b-4c5b-bd4b-911610bd3b3e", "auth_time": "2018-03-30T09:37:43.490197204Z", "auth_role": "PROVIDER", "auth_result": "SUCCESS" }]
状态码
状态码 |
说明 |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
409 |
Conflict |
500 |
Server Internal Error |
父主题: APP授权管理