This documentation is for WSO2 API Manager 2.1.0. View documentation for the latest release.

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replaced attachments pointing to AM200


  1. Start the IS server and log in to its Management Console ( https://localhost:9444/carbon).


    If you use login pages that are hosted externally to log in to the Identity Server, give the absolute URLs of those login pages in the authenticators.xml and application-authenticators.xml files in the <IS_HOME>/repository/conf/identity directory.

  2. Click Add under the Service Providers menu.
    Image Removed Image Added
  3. Give a service provider name and click Register.
    Image Removed Image Added


    In a multi tenanted environment, for all tenants to be able to log in to the API Manager web applications, do the following:

    • Click the SaaS Application option that appears after registering the service provider.
      Image Removed Image Added
      If not, only users in the current tenant domain (the one you are defining the service provider in) will be allowed to log in to the web application and you have to register new service providers for all web applications (API Store and API Publisher in this case) from each tenant space separately. For example, let's say you have three tenants as TA, TB and TC and you register the service provider in TA only. If you tick the SaaS Application option, all users in TA, TB, TC tenant domains will be able to log in. Otherwise, only users in TA will be able to log in.

    • Add the following inside the <SSOService> element in the <IS_HOME>/repository/conf/identity/identity.xml file and restart the server.

      Code Block

      If not, you get an exception stating that the SAML response signature verification fails.

    • Since the servers in a multi-tenanted environment interact with all tenants, all nodes should share the same user store. Therefore, make sure you have a shared registry (JDBC mount, WSO2 Governance Registry etc.) instance across all nodes.
  4. You are navigated to the detailed configuration page. Inside the Inbound Authentication Configuratio n section, expand SAML2 Web SSO Configuration and click Configure.
    Image Removed Image Added


    To enable tenant specific SSO with IS 5.3.0 for API_PUBLISHER and API_STORE, enable Use tenant domain in local subject identifier under the Local & Outbound Authentication Configuration section.

    Image RemovedImage Added

  5. Provide the configurations to register the API Publisher as the SSO service provider. These sample values may change depending on your configuration.

      • Issuer: API_PUBLISHER
      • Assertion Consumer URL:  https://localhost:9443/publisher/jagg/jaggery_acs.jag . Change the IP and port accordingly. This is the URL for the acs page in your running publisher app.
      • Select the following options:

        • Enable Response Signing

        • Enable  Single Logout

        • Enable Attribute Profile

          • Include Attributes in the Responses Always

      • Click Register once done.

    For example:

  6. Similarly, provide the configurations to register the API Store as the SSO service provider. These sample values may change depending in your configuration.

      • Issuer: API_STORE
      • Assertion Consumer URL:  https://localhost:9443/store/jagg/jaggery_acs.jag . Change the IP and port accordingly. This is the URL for the acs page in your running store app.
      • Select the following options:
        • Enable Response Signing
        • Enable Single Logout
        • Enable Attribute Profile

          • Include Attributes in the Responses Always

      • Click Register once done.
  7. Make sure that the responseSigningEnabled element is set to true in both the following files:
    • <API-M_HOME>/repository/deployment/server/jaggeryapps/publisher/site/conf/site.json
    • <API-M_HOME>/repository/deployment/server/jaggeryapps/store/site/conf/site.json
  8. Add a new Identity Provider in WSO2 Identity Server. For more details on configuring external IDPs in WSO2 IS, see Configuring an Identity Provider.
    • Identity Provider Name: ExternalIS
    • Do the following changes under Federated Authenticators > SAML2 Web SSO Configurations
      • Enable SAML2 Web SSO
      • Check Default
      • Set Service Provider Entity ID
      • Set SSO URL for the external IDP (e.g. https://localhost/ :9453/samls so)
      • Enable Logout
  9. Enable JIT Provisioning for the external IDP. For more information, see Configuring Just-In-Time Provisioning for an Identity Provider.
  10. Map the external IDP roles to the roles configured in API Manager. For more information on mapping roles, see Configuring Roles for an Identity Provider.
  11. Open the management console, and click Edit under Service Providers.
  12. Under Local & Outbound Authentication Configuration select Federated Authentication. Select the newly created external IDP.
  13. Add  as the Claim URI under Claim Configuration. Select the Mandatory Claim check box. Add  http:/  as the Subject Claim URI.


    Additionally, you might need to configure claims to map them to the available claims in WSO2 Identity Server. For more details, see Configuring Claims for an Identity Provider.


  1. Open the <API-M_Home>/repository/deployment/server/jaggeryapps/publisher/site/conf/site.json and modify the following configurations found under ssoConfiguration.
    • enabled: Set this value to true to enable SSO in the application
    • issuer: API_PUBLISHER. This value can change depending on the Issuer value defined in the WSO2 IS SSO configuration above.
    • identityProviderURLhttps://localhost:9444/samlsso. Change the IP and port accordingly. This is the redirecting SSO URL in your running WSO2 IS server instance.
    • keyStoreName: The keystore of the running IDP. As you use a remote instance of WSO2 IS here, you can import the public certificate of the IS keystore to the API Manager and then point to the API Manager keystore. The default keystore of the API Manager is <API-M_HOME>/repository/resources/security/wso2carbon.jks. Make sure you give the full path of the keystore here.
    • keyStorePassword: Password for the above keystore
    • identityAlias: wso2carbon
  2. Similarly, configure the API Store with SSO. The only difference in API Store SSO configurations is setting API_STORE as the issuer.

  3. Reduce the priority of the SAML2SSOAuthenticator configuration in the <API-M_HOME>/repository/conf/security/authenticators.xml file. 

    You do this as a workaround for a known issue that will be fixed in a future release. The SAML2SSOAuthenticator handler does not process only SAML authentication requests at the moment. If you set its priority higher than that of the BasicAuthenticator handler,, the SAML2SSOAuthenticator tries to process the basic authentication requests as well. This causes login issues in the API Publisher/Store.

    Code Block
    <Authenticator name="SAML2SSOAuthenticator" disabled="false">

    You can skip this step if you are using Identity Server 5.3.0 as the IDP.

  4. Access the API Publisher (e.g.,  https://localhost:9443/publisher ). Observe the request redirecting to the WSO2 IS SAML2.0 based SSO login page. For example,
    Image Removed Image Added
  5. Enter the user credentials. If the user authentication is successful against WSO2 IS, it redirects to the API Publisher with the user that is already authenticated.
  6. Access the API Store, click its Login link (top, right-hand corner) and verify that the same user is already authenticated in the API Store.