Defining a Backend Security Scheme

Defining a security scheme

The security scheme used for the API must be defined in the securityConfig section in the API definition. By default, WSO2 API Microgateway supports OAuth2. The following is an example of how you can define the security scheme as "basic". Multiple security schemes can be defined. For more information on security schemes see Defining securitySchemes .

Define security scheme

securityConfig:
    type: basic
    username: kim

Specifying basic authentication for API / resource level backend endpoints

When an actual backend service of the API is protected using basic authentication, the basic authentication parameters (username and password) must be sent to the backend. Hence, you need to define the endpoint security parameter in the OpenAPI using extensions. After you have defined the endpoint(s) using the x-wso2-endpoints extension, an API level or resource level endpoint will be able to refer to the defined endpoint. You need to define a name for the extension when defining an endpoint using the x-wso2-endpoints extension. The extension name that you specify will be used to pass the password when running WSO2 API Microgateway. The following is a sample on how to define and use endpoints by reference.

Define and refer endpoints

x-wso2-basePath: /petstore/v1
x-wso2-production-endpoints: "#/x-wso2-endpoints/myEndpoint"

paths:
    "/pet/findByStatus":
       get:
       tags:
         - pet
       summary: Finds Pets by status
       description: Multiple status values can be provided with comma separated strings
       operationId: findPetsByStatus
       x-wso2-production-endpoints: "#/x-wso2-endpoints/myEndpoint3"

x-wso2-endpoints:
  - myEndpoint:
    urls:
    - https://petstore.swagger.io/v2
    - https://petstore.swagger.io/v5
  securityConfig:
    type: basic
    username: roshan
  - myEndpoint3:
    urls:
    - https://petstore.swagger.io/v3
    - https://petstore.swagger.io/v4
  securityConfig:
    type: basic
    username: kim

A complete sample can be found here.

Invoking an API using basic authentication

When running the micro gateway, you can provide the password as an environment variable.

bash gateway <path_to_the_jar_file> --<Endpoint Name>_<Endpoint Type>_basic_username=<username> --<Endpoint Name>_<Endpoint Type>_basic_password=<password> 

- Endpoint Name: Name specified in the open API definition under `x-wso2-endpoints`
- Endpoint Type: prod or sand.
bash gateway petstore.jar --myEndpoint3_prod_basic_username=admin --myEndpoint3_prod_basic_password=123456

Note

If a username is not specified, the username defined in the API Definition section while implementing the API, will be used.

Top