This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Provisioning Out-of-Band OAuth Clients - API Manager 1.10.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

When an application access token is generated, an OAuth client is created underneath. The consumer key and consumer secret shown under a key type actually belongs to the OAuth client. There can be situations where an OAuth client is created elsewhere, but needs to be associated with an application in the API Store. For instance, in an oorganization where WSO2 Identity Server is used as the authoritative server, OAuth clients may only be created through the Identity Server. Similarly, when a third party OAuth provider is used, users might want to use previously created OAuth clients with the API Manager.

To achieve this, you can provision the OAuth clients created outside the API Store into the API Manager, thereby associating the OAuth client with an application in the API Store. Once the mapping is done, you can use it in the same way as an OAuth client created through the API Store. 

Note that when you delete an application after Out-of-Band Oauth client is provisoned, the underlying OAuth client is not deleted. It just deletes the association of the OAuth client with the application. Therefore that OAuth client will be able to create an association to another application, which means we can map the same OAuth clients' keys to a new application created in the API Store.

The steps below describe how to provision OAuth clients created outside the API Store into the API Manager:
In this example, we use a standalone API Manager instance and do this via the management console of the API Manager. 

In a setup where WSO2 Identity Server is used as the Key Manager, this step is performed in the Identity Server.


  1. Sign in to the WSO2 APIM Management Console (https://<Server Host>:9443/carbon) and click Add under Service Providers.

  2. Give a name for the service provider and click Register.
  3. Click Configure under Inbound Authentication Configuration > OAuth/OpenId Connect Configuration to add a new OAuth client.
  4. Provide a callback URL. If you do not have a callback URL, you can clear the Code and Implicit authorization grant types and add the OAuth client.

    You have now created the OAuth client and are provided with the OAuth client key and OAuth client secret.
  5. Enable the option to provide out-of-band keys by opening the <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/conf/site.json file and changing the "mapExistingAuthApps" setting to true.

    "mapExistingAuthApps" : true
  6. Sign into the WSO2 API Store https://<Server Host>:9443/store and Go to My Applications. 

    Create an application and navigate to the My Subscriptions Page.

  7. In the My Subscriptions page, you will now see a Provide Keys button for your application.

  8. Click Provide Keys and paste the consumer key and consumer secret pair, which you received in step 4. Click Save

    You have successfully provisioned an out-of-band OAuth client. 
  • No labels