本页面适用于 Apigee 和 Apigee Hybrid。
查看 Apigee Edge 文档。
本页面介绍了如何开始使用 Advanced API Security。
所需的角色
以下部分介绍了使用 Advanced API Security 执行任务所需的角色。
安全报告所需的角色
下表展示了执行与安全报告相关的任务所需的角色。
安全报告任务 | 所需的角色 |
---|---|
启用或停用 Advanced API Security | Apigee Organization Admin (roles/apigee.admin) |
创建和查看报表 | Apigee Organization Admin (roles/apigee.admin) Apigee Security Admin (roles/apigee.securityAdmin) |
查看报告 | Apigee Security Viewer (roles/apigee.securityViewer) Apigee Security Admin (roles/apigee.securityAdmin) |
风险评估所需的角色
下表展示了执行与风险评估相关的任务所需的角色。
风险评估任务 | 所需的角色 |
---|---|
创建、更新或删除自定义安全配置文件 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin) |
附加或分离安全配置文件 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin) |
查看安全得分 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin) |
列出所有安全配置文件或获取一个配置文件 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin) |
滥用行为检测所需的角色
下表显示了执行与滥用行为检测相关的任务所需的角色。
滥用行为检测任务 | 所需的角色 |
---|---|
在滥用行为检测界面中查看突发事件 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin) |
安全操作所需的角色
下表展示了执行与安全操作相关的任务所需的角色。
安全操作任务 | 所需的角色 |
---|---|
创建安全操作 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin) |
更新安全操作配置 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin) |
查看或列出安全操作 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin) |
检查强制执行状态 | Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin) |
管理订阅组织的 Advanced API Security
如需以订阅客户的身份使用 Advanced API Security,您必须在组织中启用它,如以下部分所述:
如果您不确定您使用的是订阅还是随用随付 Apigee 组织,请与您的 Apigee 组织管理员联系。
获取 Apigee 插件配置
要为订阅组织启用 Advanced API Security,您首先需要使用以下 API 调用获取当前的 Apigee 插件配置。这还会告诉您 Advanced API Security 是否启用。
curl "https://apigee.googleapis.com/v1/organizations/ORG" \ -X GET \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN"
其中
- ORG 是您组织的名称。
$TOKEN
是 OAuth 访问令牌的环境变量。
此调用返回有关您组织的基本信息,其中包括关于 Apigee 插件配置的部分,它以下面一行开头:
"addonsConfig": {
检查此部分是否包含以下条目:
"apiSecurityConfig": { "enabled": true }
如果包含,则表示组织中已启用 Advanced API Security。否则,您需要启用它,如下文所述。
启用订阅组织的 Advanced API Security
如需使用默认配置在订阅组织中启用 Advanced API Security,请发出 POST
请求,如下所示。
curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \ -X POST \ -H "Authorization: Bearer $TOKEN" \ -H "Content-type: application/json" \ -d '{ "addonsConfig": { "apiSecurityConfig": { "enabled": true } <Other entries of your current add-ons configuration> } }'
其中
- ORG 是您组织的名称。
$TOKEN
是 OAuth 访问令牌的环境变量。<Other entries of your current add-ons configuration>
包含当前 Apigee 插件配置的任何其他条目。
例如,如果当前插件配置是
"addonsConfig": { "integrationConfig": { "enabled":true }, "monetizationConfig": { "enabled":true } },
则用于启用 Advanced API Security 的命令是
curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \ -X POST \ -H "Authorization: Bearer $TOKEN" \ -H "Content-type: application/json" \ -d '{ "addonsConfig": { "apiSecurityConfig": { "enabled": true }, "integrationConfig": { "enabled": true }, "monetizationConfig": { "enabled": true } } }'
发送请求后,您将看到如下所示的响应:
{ "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "UPDATE", "targetResourceName": "organizations/apigee-docs-d", "state": "IN_PROGRESS" } }
停用管理订阅组织的 Advanced API Security
如果由于某种原因,您需要在订阅组织中停用 Advanced API Security,则可以通过发出 POST
请求来在请求正文中传递插件配置,如下所示。
curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \ -X POST \ -H "Authorization: Bearer $TOKEN" \ -H "Content-type: application/json" \ -d '{ "addonsConfig": { "apiSecurityConfig": { "enabled": false } <Include current add-ons configuration> } }'
以下提供了一个响应示例,表明操作正在进行中:
{ "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "UPDATE", "targetResourceName": "organizations/$ORG", "state": "IN_PROGRESS" } }
如需了解详情,请参阅配置组织插件 API。
管理随用随付组织的 Advanced API Security
如果您是Pay-as-you-go客户,则可以将 Advanced API Security 作为付费插件启用。如需详细了解如何为中级或综合 Apigee 环境启用 Advanced API Security 插件,请参阅管理 Advanced API Security 插件。
如果您不确定您使用的是订阅还是随用随付 Apigee 组织,请与您的 Apigee 组织管理员联系。
后续步骤
启用 Advanced API Security 后,请查看以下部分: