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-onlyGroups” 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.
      • SAML Single Sign On(SSO) using AWS Identity Provider, Add User

    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.
      • SAML Single Sign On(SSO) using AWS Identity Provider, Add User

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.
      • SAML Single Sign On(SSO) using AWS Identity Provider, Add User

    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.
      • SAML Single Sign On(SSO) using AWS Identity Provider, Add User

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.
  • 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.
    • SAML Single Sign On(SSO) using AWS Identity Provider, Add User