Rest API Common Templete

Step 3: Adding Group and IP-Based Restriction

Group Based Restrictions

• You can Enable Allow API access and select groups who can access the APIs. Users who will not be part of selected groups cannot access the APIs.
• You can Enable Read-only Groups and allow selected groups to only access READ APIs. Users of selected groups will not be able to perform WRITE operations.
• You can Enable Allow Token Generation and select groups that can generate tokens. Users who will not be part of selected groups cannot generate tokens.


IP Based Restrictions

• You can enable Restrict Access to API by IP Address to allow API access from a specified network.
• You can add the specific IP address or IP range in CIDR notations; this will block all calls that do not belong to the configured values.
• You can enable Reverse Proxy Compatibility if your instance is running behind a reverse proxy and specify the header name to retrieve the client’s real IP address.

Step 4: Public API Access

Restrict Access to Public APIs

• Public APIs do not require authentication and can be accessed anonymously. However, you can configure the API in Restrict Access to Public APIs and force authentication.


Bypass API from Authentication

• You can disable authentication through the plugin for specified APIs by adding them under Bypass API Authentication. However, default authentication might still be applicable.

Step 5: Global Settings

• The Enable REST API Authentication toggle ensures API authentication through the plugin. If disabled, the plugin will not be involved in API authentication.
• The Disable Basic Authentication toggle allows you to enforce authentication through the plugin. Basic authentication using username and password will be restricted.
• You can use the Plugin's OAuth 2.0 Tokens toggle to disable OAuth 2.0 tokens if not in use.
• The Allow PAT Tokens will allow users to use PAT tokens generated by Jira/Confluence to access the API. To restrict the use of PAT tokens and enforce authentication through the plugin you can disable the toggle.
• The Allow users to create Tokens toggle will allow all other users to generate tokens. If disabled, only admins will be able to generate tokens. However, if you have enabled Allow groups to generate tokens from group-based restrictions, you need to keep the toggle on.

Step 6: Rate Limiting

• Enable rate limiting to restrict the number of requests made by a token within the specified time frame.
• Then select the number of requests to be allowed and the time frame.
• This will enforce rate limiting on the API tokens generated through the plugin.

Step 7: Audit Logs

• You can Enable Audit Logs to log the activity with REST APIs. This will help you monitor the REST API access.
• You can also update the Scheduler settings that automatically delete logs after a specific number of days or entries.