Help Center/ API Gateway/ User Guide/ Creating a User and Granting APIG Permissions

Updated on 2024-12-02 GMT+08:00

View PDF

Creating a User and Granting APIG Permissions

This topic describes how to use Identity and Access Management (IAM) to implement fine-grained permissions control for your APIG resources. With IAM, you can:

Create IAM users for employees based on your enterprise's organizational structure. Each IAM user will have their own security credentials for accessing APIG resources.
Grant only the permissions required for users to perform a specific task.
Entrust another account or cloud service to perform O&M on your APIG resources.

If your Huawei Cloud account does not require individual IAM users, skip this chapter.

This section describes the procedure for granting permissions (see Figure 1).

Prerequisites

Learn about the permissions (see Table 1) supported by APIG and choose policies or roles according to your requirements. For the permissions of other services, see System Permissions.

**Table 1** System-defined roles and policies supported by APIG
Role/Policy Name	Description	Type	Dependency
APIG Administrator	Administrator permissions for APIG. Users granted these permissions can use all functions of API gateways.	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 gateways.	System-defined policy	None
APIG ReadOnlyAccess	Read-only permissions for APIG. Users granted these permissions can only view gateways.	System-defined policy	None

Process Flow

Figure 1 Process for granting APIG permissions

Create a user group and assign permissions.
Create a user group on the IAM console, and attach the APIG Administrator role or the APIG FullAccess policy to the group.
Create an IAM user and add it to the user group.
Create a user on the IAM console and add the user to the group created in 1.
Log in and verify permissions.
Log in to the APIG console as the created user, and verify that the user has administrator permissions for APIG.

APIG Custom Policies

Custom policies can be created to supplement the system-defined policies of APIG. For the actions that can be added to custom policies, see Permissions Policies and Supported Actions.

You can create custom policies using one of the following methods:

Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax.
JSON: Edit JSON policies from scratch or based on an existing policy.

For operation details, see Creating a Custom Policy. The following section contains examples of common APIG custom policies.

Example Custom Policies

Example 1: Allow users to create and debug APIs

{
    "Version": "1.1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "
                     apig:apis:create
                     apig:apis:debug
                 "
            ]
        }
    ]
}

Example 2: Deny API group creation
A policy with only "Deny" permissions must be used in conjunction with other policies to take effect. If the permissions assigned to a user contain both "Allow" and "Deny", the "Deny" permissions take precedence over the "Allow" permissions.

The following method can be used if you need to assign permissions of the APIG FullAccess policy to a user but you want to prevent the user from creating API groups. Create a custom policy for denying API group creation, and attach both policies to the group to which the user belongs. Then, the user can perform all operations on API gateways except creating API groups. The following is an example of a deny policy:
```
{
    "Version": "1.1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "
                     apig:apis:create
                     apig:apis:debug
                 "
            ]
        }
    ]
}
```