This documentation is for WSO2 Identity Server 5.3.0 . View documentation for the latest release.

Versions Compared


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

With the SAML2 relying party capabilities of Carbon, it is possible to set up Single Sign-On between different WSO2 Product instances where WSO2 Identity Server acts as the identity provider while other WSO2 products act as the relying party. This topic provides instructions on how to set up Single Sign-On between different WSO2 products.

Step 1 - Installing  Installing the SAML2 relying party (SAML2 SSO Authenticator) feature in a Carbon Server


You only need to do this step if "SAML2 based Single Sign-On authenticator" is not installed in your WSO2 product.


  1. Add the WSO2 online P2 repository as a new repository. Usually, the hosted P2 repository is available at this URL:
    To learn how to add a repository to the Identity Server Managing the Feature Repository in the WSO2 Product Administration Guide.
  2. Search for the word "authenticator". Select "SAML2 based Single Sign-On authenticator" from  from the result, and click " Install. "
    See Installing Features in the WSO2 Product Administration Guide.

Step 2 - Configuring  Configuring the Carbon Server to use the SAML2-based authentication instead of default username/password-based authentication

After installing the SAML2 relying party components (SAML2 SSO authenticator), it is necessary to configure the SAML2 SSO authentication component to communicate with the Identity Server for user authentication. This can be configured in the <PRODUCT_HOME>/repository/conf/security/authenticators.xml file. This file will contain configurations for different authenticators. By default, it is shipped with a sample configuration for SAML2 SSO authenticator and requires minor modifications to prior to setup.


For single sign-on to work, you need to configure the WSO2 products to share a common user store. For more information on configuring this, see Configuring the Primary User Store.

Step 3 - Configuring  Configuring the Identity Server as the Single Sign-On provider

Finally, you need to configure the Identity Server to act as the Single Sign-on provider. Each relying party should be registered as a service provider at the Identity Server-end. The following is a sample configuration for registering a Carbon server as a service provider.

  1. Sign in. Enter your username and password to log on to the Management Console
  2. Navigate to the Main menu to access the Identity menu. Click Add under Service Providers.
  3. Fill in the Service Provider Name and provide a brief Description of the service provider. Only Service Provider Name is a required field.
  4. Click Register to add the new service provider.
  5. Expand the Inbound Authentication Configuration section, followed by the SAML2 Web SSO Configuration section and click Configure.
  6. Fill in the form that appears.
    • Specify the Issuer. This should be equal to the ServiceProviderID value mentioned in the authenticators.xml of the relying party Carbon server.
    • Specify the Assertion Consumer URL. This is the URL to which the browser should be redirected after the authentication is successful. It should have this format:  https://(host-name):(port)/acs .
    • Select Use fully qualified username in SAML Response if that feature is required.
    • Select Enable Response Signing to sign the SAML2 Responses returned after the authentication.
    • Select Enable Signature Validation in Authentication Requests and Logout Requests if you need this feature configured.
    • Select Enable Single Logout so that all sessions are terminated once the user signs out from one server. You can enter a SLO Response URL and SLO Request URL if required. These indicate the endpoint that the response and reqest are sent to.
    • Select Enable Attribute Profile to enable this and add a claim by entering the claim link and clicking the Add Claim button.
    • Select Enable Audience Restriction to restrict the audience. You may add audience members using the Audience text box and clicking the Add Audience button.
  7. Expand the Local & Outbound Authentication Configuration section and do the following. 
    • Select Use tenant domain in local subject identifier to append the tenant domain to the local subject identifier.
    • Select Use user store domain in local subject identifier to append the user store domain that the user resides in the local subject identifier.
      Image Modified
  8. Click the Update button to update the details of the service provider.