Skip to main content

Configure RBAC for application roles

Configure role-based access control (RBAC) for an application to verify which API endpoints each role can access. Every task on this page starts from the RBAC page of your application.

Open the application​

Configure RBAC​

  • Click Set Up User Access.

    Set Up User Access button

  • Enter the Credential Name, select the Credential Method, and enter the required values.

    Credential name and method fields

  • Click Save Credentials to create the authentication.

    Save Credentials button

  • When prompted, enter a Role Name for the authentication you created.

    Role Name prompt

  • Click Next.

    Next button

  • Select the role by checking its checkbox in the Include In Access Test column.

    Include In Access Test checkbox

  • Click Run Access Checks to discover permissions for the selected role.

    Run Access Checks button

  • Review the discovered permissions and make changes where necessary.

    Discovered permissions

  • Click Save Access Mapping to include the configuration in the RBAC coverage categories for the next scan.

    Save Access Mapping button

  • Select the role and click Save Selection.

    Save Selection button

  • Confirm that the RBAC pill in the App Model section is green, indicating that RBAC is configured.

    Green RBAC pill in the App Model section

Edit User Access​

Edit User Access modifies the roles assigned to existing credentials and checks the access permissions for the updated role.

  • On the RBAC page, click Edit User Access.

    Edit User Access button

  • You can add new roles, delete existing roles, or update user roles. To update an existing user role, first delete the current User Role.

    Delete the current user role

  • Update the User role and click Next.

    Update the user role

  • Select the Include in Access Test checkbox and click Run Access Checks.

    Include in Access Test checkbox and Run Access Checks button

  • Check the updated User Role.

    Updated user role

  • Click Save Access Mapping.

    Save Access Mapping button

  • Select the Role and click Save Selection.

    Save Selection button

Re-Run Access Checks​

Re-Run Access Checks retests the access permissions for the selected role.

  • On the RBAC page, click Re-Run Access Checks.

    Re-Run Access Checks button

  • Recheck the permissions for the selected user role.

    Permissions for the selected user role

Retest Permissions​

Retest Permissions retests the access permissions for a selected endpoint.

  • On the RBAC page, switch off Consolidated View.

    Consolidated View toggle

  • Click the options menu for the endpoint and select Retest Permissions.

    Retest Permissions option

RBAC Map​

The RBAC (Role-Based Access Control) Map helps you verify which API endpoints are accessible for a selected role or roles.

Download RBAC Map​

  • On the RBAC page, click RBAC Map, then Download RBAC Map. You can edit this CSV file and upload it to verify role-based access permissions.

    Download RBAC Map option

Upload RBAC Map​

  • On the RBAC page, click RBAC Map, then Upload RBAC Map.

    Upload RBAC Map option

  • Click Browse files and select the RBAC Map file.

    Browse files button

  • Click Upload File.

    Upload File button

  • Verify and confirm the access permissions for each endpoint.

    Access permissions for each endpoint

Upload RBAC Map during configuration​

You can also configure RBAC in a new application using an RBAC Map CSV file.

  • On the RBAC page, click Set Up User Access.

    Set Up User Access button

  • Enter the Credential Name, select the Credential Method, and enter the required values.

    Credential name and method fields

  • Click Save Credentials to create the authentication.

    Save Credentials button

  • When prompted, enter a Role Name for the authentication you created.

    Role Name prompt

  • Click Next.

    Next button

  • Select the role by checking its checkbox in the Include In Access Test column.

    Include In Access Test checkbox

  • Click Upload RBAC Map.

    Upload RBAC Map button

  • Click Browse files and select the RBAC Map file.

    Browse files button

  • Click Upload File.

    Upload File button

  • Verify and confirm the access permissions for each endpoint.

    Access permissions for each endpoint

View RBAC endpoint logs​

  • On the RBAC page, switch off Consolidated View to see logs per endpoint.

    Consolidated View toggle

  • Check the logs.

    Endpoint logs

    note

    These logs are only visible after running access checks.

Skip Endpoints for RBAC​

Session-sensitive endpoints — such as logout, token revocation, or session invalidation — can terminate active sessions when they run during RBAC testing. Exclude these endpoints from RBAC access checks to keep your session active and avoid false access failures.

Skip endpoints​

  • On the RBAC page, click Skip Endpoints.

    Skip Endpoints button

  • Click Select Endpoints to Skip.

    Select Endpoints to Skip button

  • Select the endpoint and click Skip Selected Endpoints.

    Skip Selected Endpoints button

  • View the skipped endpoints list.

    Skipped endpoints list

Restore skipped endpoints​

  • On the RBAC page, click Skip Endpoints.

    Skip Endpoints button

  • Review the skipped endpoints list.

    Skipped endpoints list

  • Select the endpoint to restore and click Restore Selected Endpoints.

    Restore Selected Endpoints button

  • The restored endpoints are available for RBAC access checks.