When you import an OpenAPI specification to an ePortal Outbound Web Service project that contains an HTTP authentication, a new section is created in the configuration file with the same security key used in the specification.
The following table shows the security scheme section in the specification file and the equivalent values generated by the outbound project in the configuration file.
Specification file | Configuration File |
securitySchemes: basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer bearerFormat: JWT security: - basicAuth: [ ] - bearerAuth: [ ] | "SecuritySchemes": {
"basicAuth": {
"BasicAuthentication": {
"Key": "",
"Value": ""
}
},
"bearerAuth": {
"BearerAuthentication": ""
}
}
|
Basic Authentication Scheme
Prerequisite: To call a RESTful API with basic authentication using the proxy, you should set the values in the BasicAuthentication section of the configuration file with a user name and password as key-value.
When you reimport an OpenAPI Specification, these values are preserved and you can modify them when required.
Note: It is recommended to handle the user-specific parameters such as user ID and user password using the COBOL application. For more information, refer to Setting Security Parameters from COBOL Applications.
Bearer Authentication Scheme
Prerequisite: To call an external API with bearer token using the proxy, you should set the access token value in the BearerAuthentication section of the configuration file.
When you re-import an OpenAPI Specification, this value is preserved and you can modify it when required.
Note: You can obtain the bearer token from the RESTful service provider.