Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

There can be Web applications internally calling the OAuth secured APIs. Once Web applications are published and accessed through the AppManager WSO2 App Manager gateway, user is authenticated using the SAML SSO. In However, there can be Web applications which internally call OAuth-secured APIs. In this feature, you can use the same SAML token generated by the WSO2 App Manager gateway, and get an OAuth2 access token by calling the token endpoints used by these APIs.

Table of Contents
maxLevel3

The  The below diagram depicts this scenario.

Obtaining an Auth2 token by providing a SAML token flow diagramImage Modified

Prerequisites 

Make sure that following prerequisites are met before following the instructions on publishing the web application for obtaining an OAuth2 access token

Configuring the identity provider of App Manager

App Manager uses WSO2 Identity Server as the default service provider for SAML SSO authentication. You need to create a service provider in IDP for each Web application that is published through the App Manager (i.e to get the SAML SSO authentication for Web applications).

If a particular Web application is registered to obtain a OAuth2 token using the SAML response generated from the SSO authentication, when creating the service provider for this Web application, it needs to give the following mandatory details of the service provider.

  • Enable response signing
  • Enable assertion signing
  • Enable audience restriction
Info

You need to add API provider’s token endpoint as a audience restricted parameter.

 Configure WSO2 Identity Server as follows.

Image Removed

Configuring the API provider of App Manager

WSO2 App Manager uses WSO2 API Manager as the API Provider. In order to provide an OAuth token using the SAML token provided by the IDP of App Manager (WSO2 IS), APIManager needs to include IS as a trusted IDP provider. Configure WSO2 API Manager as follows.

Image Removed

...



















Publishing the

...

Web application for obtaining an OAuth2 access token 

 If a particular Web application needs accessing to access OAuth-secured APIs internally, it needs to provide the following OAuth parameters of the APIs when publishing in the Step 4 - Advanced Configuration of creating the Web application in the App Manager, as depicted below.

  • API Token Endpoint - URL of token endpoint used by the APIs.
  • API Consumer Key - the consumer keys of the OAuth APIs.
  • API Consumer Secret the consumer secret keys of the OAuth APIs.
  • API Name alias name for the APIs.

...

Once the Web application is created on App Manager, it will wrap these details and generate a new consumer/secret key pair for the Web application [WCk1, WCSk1]. Actual Web application can use this consumer/secret key pair generated by the App Manager publisherPublisher, when it need needs to get an access token to call the registered APIs. 

 You can see  Follow the steps below to view the consumer/secret key pair generated by WSO2 App Manager, 

  1. Log in to the

...

 xxxxxx insert image here xxxxxx

...

  1. App Publisher of WSO2 App Manager using the following URL with admin/admin credentials: http://<IP_ADDRESS>:9763/publisher
  2. Click on the Pizza Shack application in the Web applications list.
  3. In the the Overview section of the Web application, click OAUTH Parameters tab.
    You can see the consumer/secret keys generated for it in WSO2 App Manager as follows.
    Image Added

Invoking WSO2 AppM token API from the Web app

WSo2 App Manager itself provides a token API. Web applications need to call this token API with the consumer/secret key pair [WCk1, WCSk1] provided by the App Manager, when they need to get an access token for a particular API. 

...

Code Block
languagejava
String apiAlias = "pizzashack";
String applicationToken = base64Encode(WCk1 + ":" + WCSk1);
String payload = "grant_type=SAML2&scope=" + samlTokenId + "," + apiAlias;
httpClient.doPost("http://localhost:8280/token", applicationToken, payload, "application/x-www-form-urlencoded");

 
  • apiAlias - the alias name given when registering the API details in the App Manager publisher.  
  • applicationToken - the base64 encoded value of consumer/secret key pair provided by the App Manager.  
  • payload - the payload needs to send the grant type and the scope value. Grant type need to be set as SAML2.  Scope Scope should contain the value of samlTokenId cookie and apiAlias as comma -separated strings.
  • httpClient.doPostthe token API provided by the App Manager. Change it with the define port offset accordingly.
Note

For more information on obtaining an OAuth2 token by providing a SAML token, see the Pizza Shack sample.