Provisioning Out-of-Band OAuth2 Clients

When application keys are generated, an OAuth2 client is created underneath. The consumer key and consumer secret that appears under a key type belong to the OAuth2 client. There can be situations where an OAuth2 client is created elsewhere but needs to be associated with an application in the Developer Portal. These types of OAuth2 clients are referred to as Out-of-Band OAuth2 Clients.

For instance, in an organization where MWARE IAM (MWARE IAM) is used as the authoritative server, OAuth2 clients may only be created through the Identity Server. Similarly, when you use a third-party OAuth2 provider, you may also want to use the previously created OAuth2 clients with MWARE ESB. In such a scenario, you need to provision the OAuth2 clients that you created outside the Developer Portal into MWARE ESB by associating the OAuth2 client with an application in the Developer Portal. After the mapping is completed, the third-party OAuth2 client will work in a similar manner to an OAuth2 client that was created via the Developer Portal.

Follow the instructions below to provision an OAuth2 client that was created outside the Developer Portal into the MWARE ESB.

In this example, let's use MWARE IAM configured as a third-party Key Manager. An OAuth2 client will be created in its Management Console and will be provisioned into MWARE ESB by associating it with an application in the Developer Portal.

Step 1 - Configure a third-party key manager

Follow the steps in Configure MWARE IAM as a Key Manager to setup MWARE IAM as a third-party key manager.

Note

You can use any Key Manager mentioned under Multiple Third-party Key Manager support and configure it as a third-party key manager.

In this example, it will be assumed that MWARE IAM and MWARE ESB are up and running in https://<Server Host>:9444 and https://<Server Host>:9443 respectively.

Step 2 - Create an external OAuth2 client

  1. Sign in to the MWARE IAM Management Console (https://<Server Host>:9444/carbon) 

  2. Click Main → Service Providers → Add.

    Add Service Provider Menu

  3. Enter the name of the service provider and click Register.

    Add Service Provider

  4. Click Inbound Authentication Configuration → OAuth/OpenID Connect Configuration → Configure to add a new OAuth2 client.

    Add Oauth app

  5. Provide a Callback Url and set the Token Issuer as JWT, then click Add.

    If you do not have a Callback Url, you can clear the Code and Implicit authorization grant types and add the OAuth2 client.

    Register OAuth app

    Now you have successfully created an OAuth2 client and generated a consumer key and consumer secret for it.

    Oauth app credentials

Step 3 - Provision the out-of-band OAuth2 client

Follow the instructions below to provision the out-of-band OAuth2 client that you created in the previous step in MWARE ESB.

  1. Stop the MWARE ESB server if it is already running.

  2. Enable the option to provide out-of-band keys.

    Open <API-M_HOME>/repository/conf/deployment.toml file in a text editor and add the following configuration under the apim.devportal configuration.

    [apim.devportal]
enable_key_provisioning = true

    Note

    • The ability to provision Out-of-Band Auth client will only be available for the applications that you created after applying this configuration.
    • If you want to disable the validation of the provisioned applications, add the following config under the apim.key_manager configuration to <API-M_HOME>/repository/conf/deployment.toml file. 
      [apim.key_manager]
enable_provisioned_app_validation = false

  3. Start the server.

  4. Sign in to the Developer Portal.

    https://<Server Host>:9443/devportal

  5. Create an application.

    For more information, see Create Application.

  6. Click on the respective application to view the credential details.

    App listing

  7. Click OAuth2 Tokens under Production Keys tab and navigate to the respective key manager tab (here it is IS).

    The PROVIDE EXISTING OAUTH KEYS button appears under the Production OAuth2 Keys section.

    Note

    Out-of-band OAuth2 client can be provisioned either for production or sandbox environment. If you wish to generate keys for your sandbox, you can follow the same instructions in the Sandbox Keys tab.

    Provide Keys

  8. Paste the consumer key and consumer secret pair, which you derived in Step 2 - (5) Creating an external OAuth client.

    update-keys

  9. Click Provide.

Now you have successfully mapped an out-of-band OAuth client to an application.

Step 4 - Invoke an API

  1. Subscribe to an API via this application.

  2. Obtain an access token for it.

    You cannot obtain an access token from the Developer Portal for the provisioned applications. You need to use the command line (cURL). For more information, see Obtain Access Token.

  3. Invoke the API.

Top