

Configuring Different Endpoint Security Types¶

When there are multiple environments, to allow easily configuring environment-specific details, WSO2 API Controller (apictl) supports an additional parameter file. (Please refer Configuring Environment Specific Parameters for more information). You can specify different types of endpoint security in this file, as discussed under the below topics.

Configuring Basic or Digest Endpoint Security
Configuring OAuth 2.0 Endpoint Security

Configuring Basic or Digest Endpoint Security¶

The following is an example parameters file of an API for this scenario.

Example

environments:
    - name: dev
      configs:
        endpoints:
            production:
                url: 'https://dev.prod.wso2.com'
            sandbox:
                url: 'https://dev.sand.wso2.com'
        security:
            production:
                enabled: true
                type: digest
                username: 'admin'
                password: 'admin'
            sandbox:
                enabled: true
                type: basic
                username: 'admin'
                password: 'admin'

Under the security field, if the enabled attribute is true, you must specify the username, password and the type (can be either only basic or digest). If the enabled attribute is false, then none of the security parameters will be set. If the enabled attribute is not set (blank), then the security parameters in api.yaml file will be considered.

Configuring OAuth 2.0 Endpoint Security¶

The following is an example parameters file of an API for this scenario.

Example

environments:
    - name: dev
      configs:
        endpoints:
            production:
                url: 'https://dev.prod.wso2.com'
            sandbox:
                url: 'https://dev.sand.wso2.com'
        security:
            production:
                enabled: true
                type: oauth
                tokenUrl: https://prod.token.com
                clientId: Poc7i6mTj0ac3LyTW0szFzdt1gwanew
                clientSecret: edDEOOjlY0kgClxVlntwWVFve64a
                grantType: client_credentials
                customParameters: 
                    param1: val1
                    param2: val2
            sandbox:
                enabled: true
                type: oauth
                username: 'admin'
                password: 'password'
                tokenUrl: https://sand.token.com
                clientId: Fcd7i6mTj0ac3LyTW0szFzdt1asd
                clientSecret: rfDEOOjlY0kgClxVlntwWVFve56f
                grantType: password
                customParameters: 
                    param3: val3
                    param4: val4

It is mandatory to specify the fields type, tokenUrl, clientId, clientSecret and grantType for the OAuth 2.0 endpoint security.

The grantType can be either Client Credentials (client_credentials) or Resource Owner Password (password). If you specify the grant type as password, it is mandatory to provide the username and password.

Configuring customParameters

When setting up customParameters, if you find that there are no specific custom parameters to configure, you must use double braces to indicate the absence of any configurations.

environments:
- name: prod1
configs:
    endpoints:
        production:
            url: 'xxxxxxxxxxxx'
    security:
        production:
            enabled: true
            type: 'oauth'
            tokenUrl: 'xxxxxxxxxxxxxxx'
            clientId: 'xxxxxxxxxxxxxxx'
            clientSecret: 'xxxxxxxxxxxxxxx'
            grantType: 'client_credentials'
            customParameters: {}
    deploymentEnvironments:
        - displayOnDevportal: true
        deploymentEnvironment: Default

Top