Skip to main content

Configure authentication

Authenticated scans are where APIsec finds the vulnerabilities that matter most — authorization flaws, privilege escalation, broken object-level access — because they exercise the API as a real client. This page shows how to add credentials to an application and test them. APIsec supports API Key, Basic, OAuth 2.0, Bearer Token, HMAC, and multi-step Custom authentication.

note

Credentials are stored per application. To share one credential set across applications, see Global Credentials.

Open the credentials form​

Open your browser and visit: https://<your-tenant>.apisecapps.com


  • Click the required application.

    Select the application


  1. Open the credentials view in either of two ways:

    • Click Set Up Credentials in the Guided actions, or

      Set Up Credentials in the Guided actions

    • Click Credentials in the sidebar

      Credentials in the sidebar

  2. Click the Add Credentials + button.

    Add Credentials + button

  3. The authentication form is displayed.

    Authentication form

note

Users with View permissions cannot configure or add authentication in a shared application.


API Key Authentication​

  • Type auth name

    Enter auth name

  • From dropdown select API Key

    Select API Key

  • Fill the Header Key and Value

    Input Key Val

  • Click on Save and Test Authentication

    Save Credentials

  • Authentication Tested Successfully

    Save Credentials

  • Authentication Test Results - Authentication Resolution

    Check API Key aut is in Table

  • Authentication Test Results - API Endpoint Test Results

    Check API Key aut is in Table

  • Check the saved credentials are available in the table

    Check API Key aut is in Table

Test Authentication​

  • Click on Test Authentication Save Credentials
  • Authentication Test Results - Authentication Resolution Check API Key aut is in Table
  • Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table

Basic Authentication​

  • Type auth name

    Enter auth name

  • From dropdown select "Basic"

    Select Basic

  • Fill Username and Password

    Fill Username

  • Click on Save and Test Authentication

    Click on Save Credentials

  • Authentication saved and Tested Successfully

    Save Credentials

  • Authentication Test Results - Authentication Resolution

    Check API Key aut is in Table

  • Authentication Test Results - API Endpoint Test Results

    Check API Key aut is in Table

  • Check the saved credentials are available in the table

    Check Basic auth is in Table

    Test Authentication​

    • Click on Test Authentication Save Credentials
    • Authentication Test Results - Authentication Resolution Check API Key aut is in Table
    • Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table

OAuth 2.0 Authentications​

  • Type auth name Add auth name

  • From dropdown select "OAuth 2.0" Select Basic

  • Fill the form Select Basic

  • Click on Save and Test Authentication Click on Save Credentials

  • Authentication Test Results - Authentication Resolution Click on Save Credentials

  • Authentication saved and Tested Successfully Click on Save Credentials

  • Authentication Test Results - Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table

  • Check the saved credentials are available in the table Check OAuth 2.0 auth is in Table

    Test Authentication​

    • Click on Test Authentication Save Credentials
    • Authentication Test Results - Authentication Resolution Check API Key aut is in Table

OAuth 2.0 Authentications Advance Option​

  • Click on the row where OAuth 2.0 available in the table, it will open the OAuth 2.0 in edit mode. Check OAuth 2.0 auth is in Table
  • Click on Advance Section toggle button. Click toggle OAuth 2.0
  • Select Header from the Placement In dropdown, and fill in the Scope and Audience fields in the form. Fill Scope and Audience
  • Click on "Update and Test Authentication" Click Update and Test Authentication

Bearer Token Authentications​

  • Type Auth Name Fill the name

  • From dropdown select "Bearer Token" Fill the name

  • Fill the form Fill the name

  • Click on Save and Test Authentication Click on Save Credentials

  • Authentication Test Results - Authentication Resolution Click on Save Credentials

  • Authentication saved and Tested Successfully Click on Save Credentials

  • Authentication Test Results - API Endpoint Test Results Bearer token endpoint test results

  • Check the saved credentials are available in the table Check Bearer auth is in Table

    Test Authentication​

    • Click on Test Authentication Save Credentials
    • Authentication Test Results - Authentication Resolution Check API Key aut is in Table

Bearer Token Authentications Advance Option​

  • Click on the row where Bearer Token available in the table, it will open the Bearer Token in edit mode. Check Bearer Token auth is in Table
  • Click on Advance Section toggle . Click toggle Bearer Token
  • Select the Query Parameter from Placement In dropdown. Select Query Parameter
  • Select the Authorization from Placement Key dropdown. Select Authorization
  • Fill the required additional columns. Fill Additional form
  • Click on "Update and Test Authentication" Click Update Credentials

Custom Authentications​

Custom Authentication is designed to support complex, multi-step login flows, often needed for APIs that require chaining multiple requests, passing cookies, and extracting values from headers or response bodies.

  • Enter Credential Name Fill the name

  • From dropdown select "Custom Authentication" Select Bearer Token

  • Select Authentication Flow configured to obtain a token for APIs that require multi-step authentication.

    note

    Custom Authentication allows you to run chained requests to obtain a token through a multi-step authentication process. If no authentication flow has been set up, please contact APIsec support team.

    Fill the Authentication URL

  • Enter the credentials required to run the script. Enter Credentials

  • Token Renewal Frequency Select the duration for which the token stays valid before it must be regenerated. Enter Credentials

  • Click on Save and Test Authentication Click on Save Credentials

  • Authentication saved and Tested Successfully Click on Save Credentials

  • Authentication Test Results - Authentication Resolution Click on Save Credentials

  • Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table

  • Check the saved credentials are available in the table Check Bearer auth is in Table

    Test Authentication​

    • Click on Test Authentication Save Credentials
    • Authentication Test Results - Authentication Resolution Check API Key aut is in Table
    • Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table

HMAC Authentication​

HMAC (Hash-based Message Authentication Code) authentication secures API requests by generating a cryptographic signature using a shared secret. It verifies the authenticity and integrity of each request, ensuring that only trusted clients can access the API and that request data has not been modified during transmission.

  • Type auth name Add auth name
  • From dropdown select "HMAC" Select Basic
  • Fill the form Select Basic
  • Click on Save and Test Authentication Click on Save Credentials
  • Authentication saved and Tested Successfully Click on Save Credentials
  • Authentication Test Results - Authentication Resolution Click on Save Credentials
  • Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table
  • Check the saved credentials are available in the table Check OAuth 2.0 auth is in Table

Test authentication on a different endpoint​

  • Click on Test Authentication Save Credentials
  • Authentication Test Results - Authentication Resolution Check API Key aut is in Table
  • Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table
  • Select any other Endpoint from the dropdown Check API Key aut is in Table
  • Click on Test Authentication Check API Key aut is in Table
  • Authentication Test Results - API Endpoint Test Results Check API Key aut is in Table
note

If results show 403, try to change the endpoint and re-test

Edit authentication​

  • Click on Credentials Click on menu - App Config

  • Click on required authentication from the list Click on menu item - Auth Config

  • Update the required fields and click on Update and Test Authentication Click on menu item - Auth Config

note

Users with View permissions cannot edit authentication in shared application

Delete authentication​

  • Click on Credentials Click on menu - App Config

  • Click on Delete icon next to the Authentication. Click on menu item - Auth Config

  • Confirm Delete. Click on menu item - Auth Config

  • Authentication deleted. Click on menu item - Auth Config

    note

    Users with View permissions cannot delete authentication in shared application