Defining Access Roles

Access Roles are profiles that determine which resources a user will be able to access. It limits a public user's access to an API based on a defined rate limit (for example only 60 requests per day), a role type, and zero or more endpoints in a project. These access roles can then be assigned to specific users in the User Management page.

You can define new access roles based on one of these role types:

  • No access (default) - access to any endpoint in the project is disabled.

  • Full access (default) - full access to all endpoints in the project using a defined rate limit.

  • Custom access (user defined) - define an access role with its own rate limit, role type and zero or more selected endpoints.

To create new access roles, follow these steps.


To display Access Roles, do the following

  1. From the Home menu, select API Publishing.

  2. Enable API Publishing by clicking Enable/Disable slider to on. This will display access roles settings.

  3. Click Manage Access Roles to open the Access Roles page.

  4. Click New Access Role to open Access Roles page. Several default access roles are provided. A new access role can be created, if needed.

To create a new access role, do the following:

  1. From Home, select API Publishing.

  2. Click Manage Access Roles. This becomes visible only if API publishing is enabled.

  3. Click Access Role to create a new role.

  4. In the Create new Access Role page:

    1. Name the new access role.

    2. Set a Rate Limit Inumber of calls per timeframe).

    3. Select a Role type:

      1. all_access - access all endpoints.

      2. no_access - prevent access to any endpoint.

      3. custom_access - use Ctrl-click to select one or more of the available endpoints.

  5. Click Create to save the new access role.

Create a new access role