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.

  1. From the Home menu, select API Publishing.

  2. Click Manage Access Roles to add new API users and set rate limits.

  3. In the Access Roles page, click New Access Role.

  4. In the Create New access Role page, define a new role:

    1. Provide a name for the access role.

    2. Set the rate limit by setting the numbers of calls per timeframe.

    3. Select a role type. For access all endpoints, select all_access. To prevent access to any endpoint, select no_access. To have access to only a selection of endpoints, select custom_access.

    4. Highlight zero or more of the available endpoints in the project using shift-click. The selected endpoints will be highlighted.

  5. Click Create to save the new access role.

Adding a new access role
Creating an Access Role
New access role added and applied to an endpoint