Understanding Custom Roles and Role Collections

Oct 13, 2025 by leolavanderia.com.br 144 views

Understanding Custom Roles and Role Collections

In the context of API Products, custom roles and role collections play a crucial role in restricting access to sensitive data. A custom role is a specific set of permissions that defines what actions a user can perform on an API Product. On the other hand, a custom role collection is a group of custom roles that can be assigned to a user or a group of users. In this article, we will guide you through the order of steps for creating a custom role to restrict access to API Products.

Step 1: Creating a Custom Role

To create a custom role, follow these steps:

Log in to the API Portal and navigate to the API Products section.
Click on the Custom Role tab and then click on the Create Custom Role button.
Enter a name and description for the custom role.
In the Permissions section, select the permissions that you want to assign to the custom role.
Click on the Save button to save the custom role.

Note: At this stage, you have created a custom role, but it is not yet assigned to any role collection.

Step 2: Assigning the Custom Role to the Product

To assign the custom role to the product, follow these steps:

Navigate to the API Products section and click on the product that you want to assign the custom role to.
Click on the Assign Permissions button.
Select the custom role that you created in Step 1.
Click on the Save button to save the assignment.

Note: At this stage, the custom role is assigned to the product, but it is not yet part of a role collection.

Step 3: Creating a Custom Role Collection

To create a custom role collection, follow these steps:

Navigate to the Custom Role Collection tab.
Click on the Create Custom Role Collection button.
Enter a name and description for the custom role collection.
In the Custom Roles section, select the custom roles that you want to include in the role collection.
Click on the Save button to save the custom role collection.

Note: At this stage, you have created a custom role collection and assigned the custom role to the role collection.

Step 4: Assigning the Custom Role Collection to the Product

To assign the custom role collection to the product, follow these steps:

Navigate to the API Products section and click on the product that you want to assign the custom role collection to.
Click on the Assign Permissions button.
Select the custom role collection that you created in Step 3.
Click on the Save button to save the assignment.

Note: At this stage, the custom role collection is assigned to the product, and the custom role is part of the role collection.

Understanding the Relationship between Custom Roles and Role Collections

A custom role collection can contain multiple custom roles, and a custom role can be part of multiple role collections. This allows you to create a hierarchy of permissions and assign them to users or groups of users.

Best Practices for Creating Custom Roles and Role Collections

Use meaningful names: Use descriptive names for custom roles and role collections to make it easy to identify what permissions they contain.
Use a consistent naming convention: Use a consistent naming convention for custom roles and role collections to make it easy to identify what permissions they contain.
Use a hierarchical structure: Use a hierarchical structure for custom roles and role collections to make it easy to assign permissions to users or groups of users.
Test and validate: Test and validate the custom roles and role collections to ensure that they work as expected.

Conclusion

Q: What is the difference between a custom role and a custom role collection?

A: A custom role is a specific set of permissions that defines what actions a user can perform on an API Product. A custom role collection, on the other hand, is a group of custom roles that can be assigned to a user or a group of users.

Q: How do I create a custom role?

A: To create a custom role, follow these steps:

Log in to the API Portal and navigate to the API Products section.
Click on the Custom Role tab and then click on the Create Custom Role button.
Enter a name and description for the custom role.
In the Permissions section, select the permissions that you want to assign to the custom role.
Click on the Save button to save the custom role.

Q: How do I assign a custom role to a product?

A: To assign a custom role to a product, follow these steps:

Navigate to the API Products section and click on the product that you want to assign the custom role to.
Click on the Assign Permissions button.
Select the custom role that you created.
Click on the Save button to save the assignment.

Q: How do I create a custom role collection?

A: To create a custom role collection, follow these steps:

Navigate to the Custom Role Collection tab.
Click on the Create Custom Role Collection button.
Enter a name and description for the custom role collection.
In the Custom Roles section, select the custom roles that you want to include in the role collection.
Click on the Save button to save the custom role collection.

Q: How do I assign a custom role collection to a product?

A: To assign a custom role collection to a product, follow these steps:

Navigate to the API Products section and click on the product that you want to assign the custom role collection to.
Click on the Assign Permissions button.
Select the custom role collection that you created.
Click on the Save button to save the assignment.

Q: Can I assign multiple custom roles to a single product?

A: Yes, you can assign multiple custom roles to a single product. This allows you to create a hierarchy of permissions and assign them to users or groups of users.

Q: Can I assign a custom role collection to multiple products?

A: Yes, you can assign a custom role collection to multiple products. This allows you to create a hierarchy of permissions and assign them to users or groups of users.

Q: How do I manage custom roles and role collections?

A: To manage custom roles and role collections, follow these steps:

Navigate to the Custom Role tab.
Click on the Manage Custom Roles button.
Select the custom role that you want to manage.
Click on the Edit button to edit the custom role.
Click on the Save button to save the changes.

Q: How do I delete a custom role or role collection?

A: To delete a custom role or role collection, follow these steps:

Navigate to the Custom Role tab.
Click on the Manage Custom Roles button.
Select the custom role or role collection that you want to delete.
Click on the Delete button to delete the custom role or role collection.

Conclusion

Creating custom roles and role collections is a crucial step in restricting access to API Products. By following the order of steps outlined in this article and the FAQs, you can create custom roles and role collections that meet your organization's security requirements. Remember to use meaningful names, a consistent naming convention, a hierarchical structure, and to test and validate the custom roles and role collections.