Apidog offers a wide range of security scheme types, supporting various authentication methods, including:1.
API Key β Authenticate using a key passed via Header, Query, or Cookie.
2.
Bearer Token β Authenticate using the Authorization: Bearer header.
3.
JWT β Authenticate with tokens in JSON Web Token format.
4.
Basic Auth β Use a username and password for basic authentication.
5.
Digest Auth β More secure than basic auth.
6.
OAuth 2.0 β A widely adopted authorization standard supporting multiple grant types.
7.
OAuth 1.0 β An earlier version of OAuth with a different signature mechanism.
8.
Hawk Authentication β HMAC-based authentication protocol.
9.
AWS Signature β Signature-based authentication used for Amazon AWS services.
10.
Kerberos β Ticket-based network authentication protocol.
11.
NTLM Authentication β Authentication protocol developed by Microsoft.
12.
Akamai EdgeGrid β Authentication method used by the Akamai API platform.
13.
Customize β Allows you to define and use authentication methods that arenβt natively supported by Apidog.
Creating Security Schemes Manually#
1
In your project, navigate to
Components β
Security Schemes at the left sidebar, then click
New Security Scheme.
2
Select the security scheme type and fill in the name and relevant configuration.
3
Click
Save to complete the creation process.
4
In the editing view of the security scheme, click
Advanced Configuration at the bottom of the page.
The system will display the OAS (OpenAPI Specification) code for the current security scheme, available in both JSON and YAML formats.You can directly edit here to define more complex specifications. The system will update the security scheme settings based on your changes.Creating Security Schemes via OAS Import#
When importing an OpenAPI file that includes security schemes, Apidog will automatically detect and create corresponding security schemes. These will appear in the projectβs Security Schemes list.If security schemes are referenced to specific endpoints or set globally in the OpenAPI file, Apidog will not automatically apply them. After importing the file, you will need to manually assign the security schemes to the relevant endpoints.
Creating OAuth 2.0 Security Scheme#
OAuth 2.0 is a widely used authorization framework, and Apidog offers full support for it. To create an OAuth 2.0 security scheme, configure the following:1.
Grant Type: Choose from Authorization Code, Client Credentials, Implicit, or Password.
2.
URL Settings: Based on the selected grant type, configure the relevant URLs:Callback URL (also known as Redirect URL)
3.
Scope Settings (Define the permission scopes your app can request)Add scope names and descriptions
Configure different sets of scopes for each grant type
4.
Click the Test button to open the test panel. Fill in the Client ID, Client Secret, and other required fields to test and verify your OAuth 2.0 configuration.
Modified atΒ 2025-04-25 11:25:55
