Permissions Management
If you need to assign different permissions to personnel in your enterprise to access your APIG resources, Identity and Access Management (IAM) is a good choice for fine-grained permissions management. IAM provides identity authentication, permissions management, and access control. If your HUAWEI ID does not require IAM for permissions management, you can skip this section.
IAM is a free service. You only pay for the resources in your account.
With IAM, you can control access to specific Huawei Cloud resources. For example, if you want some software developers in your enterprise to use APIG resources but do not want them to delete resources or perform any other high-risk operations, you can grant permission to use APIG resources but not permission to delete them.
IAM supports role/policy-based authorization and identity policy-based authorization.
The following table describes the differences between these two authorization models.
|
Authorization Model |
Core Relationship |
Permissions |
Authorization Method |
Scenario |
|---|---|---|---|---|
|
Role/Policy |
User-permission-authorization scope |
|
Assigning roles or policies to principals |
To authorize a user, you need to add it to a user group first and then specify the scope of authorization. It provides a limited number of condition keys and cannot meet the requirements of fine-grained permissions control. This method is suitable for small- and medium-sized enterprises. |
|
Identity policy |
User-policy |
|
|
You can grant permissions directly to a user. A variety of key conditions are available for more fine-grained permissions control. However, this model requires a certain level of expertise and is suitable for medium- and large-sized enterprises. |
Assume that you want to grant IAM users the permissions needed to create ECSs in CN North-Beijing4 and OBS buckets in CN South-Guangzhou. With role/policy-based authorization, you need to create two custom policies and assign them to the IAM users. With identity policy-based authorization, the administrator only needs to create one custom identity policy and configure the condition key g:RequestedRegion for the policy, and then attach the policy to the principals or grant the principals access to the specified regions. Identity policy-based authorization is more flexible than role/policy-based authorization.
Policies/identity policies and actions in the two authorization models are not interoperable. You are advised to use the identity policy-based authorization model. For details about system-defined permissions, see System-defined Permissions in Role/Policy-based Authorization and Identity Policy-based Permissions Management.
For more information about IAM, see IAM Service Overview.
System-defined Permissions in Role/Policy-based Authorization
APIG supports role/policy-based authorization. New IAM users do not have any permissions assigned by default. You need to first add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups and can perform specified operations on cloud services based on the permissions they have been assigned.
APIG is a project-level service deployed for specific regions. When you set Scope to Region-specific projects and select the specified projects (for example, ap-southeast-2) in the specified regions (for example, AP-Bangkok), the users only have permissions for ECSs in the selected projects. If you set Scope to All resources, the users have permissions for ECSs in all region-specific projects. When accessing APIG, the users need to switch to the authorized region.
The following table lists all the system-defined permissions for APIG. System-defined policies in role/policy-based authorization are not interoperable with those in identity policy-based authorization.
|
Role/Policy Name |
Description |
Type |
Dependency |
|---|---|---|---|
|
APIG Administrator |
Administrator permissions for APIG. Users granted these permissions can use all functions of APIG. |
System-defined role |
If a user needs to create, delete, or change resources of other services, the user must also be granted administrator permissions of the corresponding services in the same project. |
|
APIG FullAccess |
Full permissions for APIG. Users granted these permissions can use all functions of APIG. |
System-defined policy |
Actions required for creating yearly/monthly gateways:
|
|
APIG ReadOnlyAccess |
Read-only permissions for APIG. Users granted these permissions can only view APIG. |
System-defined policy |
None |
Table 3 lists the common operations supported by system-defined permissions for APIG.
|
Operation |
APIG Administrator |
APIG FullAccess |
APIG ReadOnlyAccess |
|---|---|---|---|
|
Creating a dedicated gateway |
√ |
√ |
x |
|
Querying dedicated gateways |
√ |
√ |
√ |
|
Querying details of a dedicated gateway |
√ |
√ |
√ |
|
Updating a dedicated gateway |
√ |
√ |
x |
|
Publishing an API |
√ |
√ |
x |
Table 4 lists the roles or policies of the dependent services of the APIG console. You can configure roles or policies by referring to this table.
|
Console Function |
Dependent Service |
Role/Policy Required |
|---|---|---|
|
Importing a CSE microservice |
CSE |
To import a CSE microservice, an IAM user must be granted APIG FullAccess and CSE ReadOnlyAccess. |
|
Interconnecting with APM applications |
APM |
After assigning the APIG FullAccess permission to an IAM user, you need to add the following permissions: apm:apm2BusinessBusiness:list, apm:apm2Admin:create, apm:apm2Admin:update, apm:apm2Admin:delete, and apm:apm2Admin:get. Then, the IAM user can bind APM applications to an APIG gateway. |
|
Query an LTS structuring configuration |
Log Tank Service (LTS) |
To query LTS structuring configurations, an IAM user must be granted the APIG FullAccess and lts:structConfig:get permissions. |
Identity Policy-based Permissions Management
APIG supports authorization with identity policies. Table 5 lists all the system-defined policies for APIG. System-defined identity policies and system-defined policies in the two authorization models are not interoperable.
|
Identity Policy Name |
Description |
Type |
|---|---|---|
|
APIGFullAccessPolicy |
Full permissions for APIG. |
System-defined identity policy |
|
APIGReadOnlyAccessPolicy |
Read-only permissions for APIG. |
System-defined identity policy |
Table 6 lists the common operations supported by system-defined policies for APIG.
|
Operation |
APIGFullAccessPolicy |
APIGReadOnlyAccessPolicy |
|---|---|---|
|
Querying dedicated gateways |
√ |
√ |
|
Querying details of a dedicated gateway |
√ |
√ |
|
Publishing an API or taking an API offline |
√ |
x |
Table 7 lists the identity policies of the dependent services of the APIG console. You can configure identity policies by referring to this table.
|
Console Function |
Dependent Service |
Identity Policy Required |
|---|---|---|
|
Importing a CSE microservice |
CSE |
To import a CSE microservice, an IAM user must be granted APIGFullAccessPolicy and CSEReadOnlyPolicy. |
|
Interconnecting with APM applications |
APM |
To bind an APM application list to an APIG gateway, an IAM user must be assigned the APIGFullAccessPolicy and the following permissions: apm:application:list, apm:apm2Admin:create, apm::updateAdminInfo, apm::deleteAdminInfo, and apm::getAdminInfo. |
|
Query an LTS structuring configuration |
LTS |
To query LTS structuring configurations, an IAM user must be granted the APIGFullAccessPolicy and lts:structConfig:getStructConfig permissions. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
