Update User Roles

Role-Based Access Control (RBAC) links permissions to roles instead of directly to users. Users are then assigned these roles, simplifying access management, enhancing efficiency, and reducing errors. This guide will walk you through managing role-based access control using custom role, permission policy, and permission boundary of API7 Enterprise.

Update a User Role

1. Select Organization from the top navigation bar, and then select Users.
2. Click Update Roles for the target user.
3. Add or remove roles.
4. Click Update.

note

To view the permissions for every role, select Organization from the top navigation bar and select Roles.

Roles and permission policies are combined to control access. Here's an example of isolating access to environments using a custom role and permission policy.

Define Permission Policies

1. Create three gateway groups: test, UAT, and production.

2. Select Organization from the top navigation bar, and then select Permission Policies.

3. Click + Add Policy. In the + Add Permission Policy dialog box, do the following:

   • In the Name field, enter test-gateway-group-full-access.

   • In the Policy editor field, enter the configuration:

      {
        "statement": [
          {
            "resources": [
              "arn:api7:gateway:gatewaygroup/b6db7341-fc1f-4cee-a318-3e782a163d24"
            ],
            "actions": [
              "<.*>"
            ],
            "effect": "allow"
          },
          {
            "resources": [
              "arn:api7:gateway:gatewaygroup/b6db7341-fc1f-4cee-a318-3e782a163d24/publishedservice/<.*>"
            ],
            "actions": [
              "<.*>"
            ],
            "effect": "allow"
          }
        ]
      } 
     note

     The resource ID should be consistent with the gateway groups created. Please change it per your use.

   • Click Add.

4. Click + Add Policy. In the + Add Permission Policy dialog box, do the following:

   • In the Name field, enter uat-gateway-group-full-access.

   • In the Policy editor field, enter the configuration:

      {
        "statement": [
          {
            "resources": [
              "arn:api7:gateway:gatewaygroup/45a06edc-4a93-4bea-a437-3f153b56254c"
            ],
            "actions": [
              "<.*>"
            ],
            "effect": "allow"
          },
          {
            "resources": [
              "arn:api7:gateway:gatewaygroup/45a06edc-4a93-4bea-a437-3f153b56254c/publishedservice/<.*>"
            ],
            "actions": [
              "<.*>"
            ],
            "effect": "allow"
          }
        ]
      } 

   • Click Add.

5. Click + Add Policy. In the + Add Permission Policy dialog box, do the following:

   • In the Name field, enter production-gateway-group-full-access.

   • In the Policy editor field, enter the configuration:

      {
        "statement": [
          {
            "resources": [
              "arn:api7:gateway:gatewaygroup/edc12ecd-94a5-49b2-b82d-8d1113e6cd86"
            ],
            "actions": [
              "<.*>"
            ],
            "effect": "allow"
          },
          {
            "resources": [
              "arn:api7:gateway:gatewaygroup/edc12ecd-94a5-49b2-b82d-8d1113e6cd86/publishedservice/<.*>"
            ],
            "actions": [
              "<.*>"
            ],
            "effect": "allow"
          }
        ]
      } 

   • Click Add.

Define Custom Roles

1. Select Organization from the top navigation bar, and then select Roles.
2. Click + Add Custom Role. In the + Add Custom Role dialog box, do the following:
   • In the Name field, enter Development Team Member.
   • Click Add.
3. Create two other roles Development Team Leader and Test Engineer in the same way.

Assign Roles with Controlled Access

1. Click Development Team Member and enter the role page.
2. Click + Attach Policy.In the Attach Policy dialog box, do the following:
   • In the Permission Policies field, select test-gateway-group-full-access.
   • Click Submit. This allows them to make changes solely in the test environment.
3. Assign test-gateway-group-full-access and uat-gateway-group-full-access policies to Development Team Leader. This enables them to work in both test and UAT environments, potentially including the ability to synchronize stable configurations from test to UAT.
4. Assign uat-gateway-group-full-access and production-gateway-group-full-access policies to Test Engineer. This restricts their access to UAT and Production environments, focusing on new API testing and publishing tasks.

Validate

1. Log in to API7 Enterprise using an account with the Development Team Member role and can only have access to the Test gateway group.
2. Log in to API7 Enterprise using an account with the Development Team Leader role and can only have access to the Test and UAT gateway groups.
3. Log in to API7 Enterprise using an account with the Test Engineer role and can only have access to the UAT and Production gateway groups.

Set Role Mapping (SSO Required)

Users who meet the defined key-value mapping rules will be automatically assigned the corresponding roles upon login. See Set Role Mapping for details.

note

Role mapping takes precedence over manual role assignments. Any manual adjustments to a user's roles will be overwritten upon the next user login when role mapping is active.

Set User Permission Boundary

A user's effective permissions are determined by the intersection of their assigned roles and their permission boundary. This means a user's action is permitted only when:

• Allowed by at least one assigned role.
• Allowed by at least one permission boundary (if present).
• Not denied by any assigned role or permission boundary.

Here is an example of restricting access to licenses using permission boundaries. Below is an interactive demo that provides a hands-on introduction.

Create Permission Policy and Set Permission Boundary

1. Select Organization from the top navigation bar, and then select Permission Policies.

2. Click + Add Policy. In the + Add Permission Policy dialog box, do the following:

   • In the Name field, enter no-access-to-license.

   • In the Policy editor field, enter the configuration:

      {
        "statement": [
          {
            "resources": [
              "arn:api7:iam:organization/*"
            ],
            "actions": [
              "iam:UpdateLicense"
            ],
            "effect": "deny"
          },
          {
            "resources": [
              "<.*>"
            ],
            "actions": [
              "<.*>"
            ],
            "effect": "allow"
          }
        ]
      }
     note

     This policy allows access to all the resources except the license.

   • Click Add.

3. Select Organization from the top navigation bar, and then select Roles.

4. Click + Add Custom Role. In the + Add Custom Role dialog box, do the following:

   • In the Name field, enter Test Engineer.
   • Click Add.

5. Click + Attach Policy. In the Attach Policy dialog box, do the following:

   • In the Permission Policies field, select no-access-to-license.
   • Click Submit.

6. Select Organization from the top navigation bar, and then select Users.

7. Click + Invite User. In the Invite User dialog box, do the following:

   • In the Username field, enter Tom.
   • Set a one-time password for Tom.
   • In the Permission Boundary field, select no-access-to-license.
   • Click Invite.

8. Click Update Roles. In the Update Roles dialog box, do the following:

   • In the Roles field, select Test Engineer.
   • Click Update.

Validate

1. Log in to API7 Enterprise using Tom's account.
2. Select Organization from the top navigation bar, and then select License.
3. Click the editing logo on the license page, and can see the following note, showing that access is denied: Permission denied. Your role does not allow this action. Please contact your administrator if you need additional access.

Update Tom's Roles

1. Select Organization from the top navigation bar, and then select Roles.
2. Click Update Roles.
3. In the Update Roles dialog box, do the following:
   • In the Roles field, add a new role and select Super Admin.
   • Click Update.

Validate

1. Log in to API7 Enterprise using Tom's account.
2. Select Organization from the top navigation bar, and then select License.
3. Click the editing logo on the license page, and can see the following note, showing that access is denied: Permission denied. Your role does not allow this action. Please contact your administrator if you need additional access.

Set Permission Boundary Mapping (SSO Required)

Users who meet the defined key-value mapping rules will be automatically assigned the corresponding permission boundary upon login. See Set Permission Boundary Mapping for details.

note

Permission boundary mapping takes precedence over manual permission boundary modification. Any manual adjustments to a user's permission boundaries will be overwritten upon the next user login when permission boundary mapping is active.

Additional Resources

• Key Concepts
  • Roles and Permission Policies
• Getting Started
  • Create Custom Role