We now support multiple authentication schemes and related information in our API Transformer for all applicable API description formats including OpenAPI, RAML, Postman and Insomnia. You can now convert between these formats without losing important authentication details.
What was Supported Before?
Only a single authentication scheme was loaded per API and all other schemes were ignored. This meant that:
- If some endpoints of the API used one authentication scheme while others used a different scheme, only the first authentication scheme was globally applied and assumed for all endpoints that required authentication. The endpoint level authentication was used to override global authentication only when it needed to specify different OAuth 2.0 scopes.
- If an endpoint needed multiple authentication schemes to complete its authentication flow, only the first authentication scheme was considered and information about the other schemes was ignored.
- Each OAuth 2.0 grant type was considered as a separate authentication scheme. If an API allowed multiple grant types, information about only the first grant type was imported.
The authentication scheme was exported with a custom name and the user-defined name was ignored.
Support for multiple authentication schemes and related features has been added for the following API description formats: OpenAPI (
v1.x), RAML (
v0.8), Postman Collections (
v1.0), Insomnia (
v3). A detailed breakdown of what has been added is discussed below.
Support Added for Multiple Authentication Schemes
If your API defines multiple authentication schemes, these schemes will now be transformed with complete information including authentication type specific details as well as user-defined authentication scheme name and descriptive content.
Supported authentication schemes are listed here.
Merging APIs With Different Authentication Schemes
If you are merging multiple APIs together that make use of different authentication schemes, these authentication schemes will now also be merged together without conflicts. This is in contrast to before when the merging process was terminated if it encountered different authentication schemes.
Support Added for Applying Different Authentication Schemes
Support has been added in API Transformer for the various mechanisms to apply authentication on endpoints which are discussed below:
Global vs Endpoint Level Authentication
In OpenAPI, RAML, and Postman collections, authentication schemes can be applied either globally to all endpoints or for specific endpoints only. The endpoint level authentication overrides any globally applied authentication.
Authentication Options and Groups
Regardless of where the authentication is applied, however, an endpoint can have a list of authentication scheme options out of which one must be satisfied. An authentication option can also be an authentication scheme group (supported only in OpenAPI
v2.0) where multiple authentication schemes need to be satisfied in order to complete the authentication process. RAML (
v0.8) supports only ungrouped authentication options. On the other hand, Postman collections (
v1.0) and Insomnia allows only one authentication scheme to be applied per endpoint.note
When exporting to formats like Postman collection or Insomnia where only single authentication schemes are supported per endpoint, a non-grouped authentication scheme will be given more precedence, if available.
Ability to Extend Applied Authentication Information Via Extensions
When specifying security options in OpenAPI (
v2.0), you can now extend the security information with additional metadata like name or description to improve output, where applicable. This can be done through our new vendor extension
x-security-options-meta, more details of which you can find here.
Support Added for Optional Authentication
v0.8) and OpenAPI (
v2.0) support optional authentication for endpoints. This is now supported in API Transformer as well.
- RAML 1.0
- OpenAPI 3.x
title: Example API
type: OAuth 2.0
authorizationGrants: [ authorization_code ]
securedBy: [null, oauth_2_0]
title: Example API
- oauth_2_0: 
New Validation Rules Added
The following new validation rules related to authentication have been added:
- non-empty-authentication-scheme-name (APIMATICPOSTPROCESS_V103)
- non-null-non-empty-applied-authentication-scheme-name (APIMATICPOSTPROCESS_V104)
- unique-authentication-option-name (APIMATICPOSTPROCESS_V105)
- unique-authentication-options (APIMATICPOSTPROCESS_V106)
- authentication-scheme-referenced-by-auth-option (APIMATICPOSTPROCESS_V107)
- unique-authentication-schemes-in-group-auth-option (APIMATICPOSTPROCESS_V108)
- two-or-more-authentication-schemes-in-group-auth-option (APIMATICPOSTPROCESS_V109)
- valid-authentication-scheme-name (APIMATICPRE_V070)
- authentication-scheme-referenced-by-auth-option (APIMATICPRE_V071)
- non-null-non-empty-applied-authentication-scheme-name (APIMATICPRE_V072)
- pre-defined-authentication-scheme (APIMATICPRE_V073)
- unique-authentication-option-name (APIMATICPRE_V074)
- unique-authentication-options (APIMATICPRE_L023)
- unique-authentication-schemes-in-group-auth-option (APIMATICPRE_L024)
- two-or-more-authentication-schemes-in-group-auth-option (APIMATICPRE_L025)
How to Avoid Changes in Output?
If you wish to avoid receiving any changes to your output which are discussed above, you can opt out of them by setting the import flag value
false in a metadata file uploaded along with your API description file. For more details on how to create a metadata file and add import settings, please visit this link.
If you are merging multiple APIs together, you will additionally need to set the
MergeMultipleAuthentication merge setting value to
false as well. For more details, please visit this link.