Configuring Identity Server as IDP for SSO¶
The Single Sign-On with OpenID Connect feature is enabled by default in the API Manager.
The Single Sign-On with SAML 2.0 feature in the API Manager is implemented according to the SAML 2.0 browser-based SSO support that is facilitated by WSO2 Identity Server (WSO2 IS). This feature is available in any WSO2 IS version from 4.1.0 onwards. Note that WSO2 IS 5.10.0 is used in this guide. WSO2 Identity Server acts as an identity service provider of systems enabled with Single Sign-On, while the Web applications act as SSO service providers. Using this feature, you can configure SSO with SAML 2.0 across the API Publisher and Developer Portal. After configuring, you can access the Developer Portal or API Publisher in a single authentication attempt.
The topics below explain the configurations.
- Configuring Identity Server as IDP for SSO
- Configuring WSO2 API Manager as Service Provider for Identity Server
- Configuring WSO2 Identity Server as a SAML 2.0 SSO Identity Provider
- Configuring WSO2 API Manager apps as SAML 2.0 SSO service providers
In this documentation, MySQL is used as the database to configure WSO2 API Manager with WSO2 Identity Server. For instructions on replacing the default H2 database with MySQL, see Setting up MySQL.
Configuring WSO2 API Manager as Service Provider for Identity Server¶
Start WSO2 Identity Server.
You also can change port offset value in
<IS_HOME>/repository/conf/carbon.xmlfile. Add the following to the
[server] offset = "1"
What is port offset?
The port offset feature allows you to run multiple WSO2 products, multiple instances of a WSO2 product, or multiple WSO2 product clusters on the same server or virtual machine (VM). The port offset defines the number by which all ports defined in the runtime, such as the HTTP/S ports, will be offset. For example, if the HTTPS port is defined as 9443 and the port offset is 1, the effective HTTPS port will be 9444.
Sign in to the WSO2 IS Management Console UI (e.g.,
If you use sign-in pages that are hosted externally to sign in to the Identity Server, give the absolute URLs of those login pages in the
application-authenticators.xmlfiles in the
Select Add under the Service Providers.
Enter a service provider name and click Register.
In a multi-tenanted environment, for all tenants to be able to sign in to the APIM Web applications, do the following:
Click the SaaS Application option that appears after registering the service provider. If not, only users in the current tenant domain (the one you are defining the service provider in) will be allowed to sign in to the Web application and you have to register new service providers for all Web applications (Developer Portal 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 sign in. Otherwise, only users in TA will be able to sign in.
Because 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.
You are navigated to the detailed configuration page.
Click and expand the Inbound Authentication Configuration section, click and expand SAML2 Web SSO Configuration, and click Configure.
To enable tenant-specific SSO with IS 5.10.0 for the API Publisher and Developer Portal - 1. Click and expand the Local & Outbound Authentication Configuration section. 2. Select Use tenant domain in local subject identifier.
Provide the configurations to register the API Publisher as the SSO service provider.
These sample values may change depending on your configuration.
- Issuer: apim
- Assertion Consumer URL:
https://localhost:9443/commonauth. Change the IP and port accordingly. This is the URL for the Assertion Consumer Services (ACS) page in your running publisher app.
- Response Signing Algorithm: rsa-sha256
Select the following options:
- Enable Response Signing
- Enable Signature Validation in Authentication Requests and Logout Request
- Enable Single Logout
Upload the public certificate of the API Manager by selecting Select SP Certificate Type.
Configuring WSO2 Identity Server as a SAML 2.0 SSO Identity Provider¶
Similarly, add the Identity Server as an identity provider configurations in
https://localhost:9443/carbon. These sample values may change depending in your configuration.
Start API Manager
Sign in to the WSO2 API Management Console UI (e.g.
Select Add under the Identity Providers menu.
Upload the public certificate of Identity Server under Identity Provider Public Certificate.
Configure Federated authenticators > SAML2 Web SSO Configurations
- Identity Provider Name: is
Service Provider Entity ID: apim
This value can change depending on the Issuer value defined in WSO2 IS SSO configuration above.
Identity Provider Entity ID: localhost
- SSO URL:
https://localhost:9444/samlssoChange the IP and port accordingly. This is the redirecting SSO URL in your running WSO2 IS server instance.
- Signature Algorithm: RSA with SHA256
- Select the following options:
- Enable SAML2 Web SSO
- Enable Authentication Request Signing
- Enable Authentication Response Signing
- Enable Logout Request Signing
- Single Logout Profile
Enable JIT Provisioning users since the userstore is not shared between IS and APIM. The users who will be JIT provisioned should be assigned the relevant role (Internal/creator, Internal/publisher, Internal/subscriber) for them to be able to successfully login to Publisher and Devportal.
Click on Register.
Make sure that your service provider configuration in WSO2 Identity Server and the identity provider configuration in WSO2 API Manager is similarly reflected on each other. Example:
- If the Response Signing Algorithm in WSO2 Identity Server is rsa-sha256, then the Signature Algorithm in WSO2 API Manager should be RSA with SHA256.
- If you select Enable Single Logout in Identity Server, then select Single Logout Profile in WSO2 API Manager.
Configuring WSO2 API Manager apps as SAML 2.0 SSO service providers¶
Sign in to the WSO2 API Management Console UI (
List the service providers, and click Edit on the relevant application for the Publisher, Developer Portal, or Admin Portal.
Note that the Publisher, Developer Portal, and Admin Portal service providers will be listed under Service Providers after you have logged in to each of the portals at least once.
Click and expand Local and Outbound Authentication Configuration, and select Identity Provider as the Federated Authentication.
Repeat the above steps (Step 2 to Step 4) to configure SAML2 SSO for any of the Publisher, Developer Portal or Admin Portal applications.
Access the API Publisher:
Observe the request redirect to the WSO2 IS SAML2.0 based SSO login page.
Similarly, access the Developer Portal
https://localhost:9443/devportal) and the Admin Portal
Enter user credentials.
If the user authentication is successful against WSO2 IS, it will redirect to the particular Web application with the user already authenticated.
If you sign in to the Publisher, then access the Developer Portal application, click Login and verify that the same user is already authenticated in the Developer Portal.
When Just-In-Time Provisioning is enabled, the user details will be saved in the API Manager user store. User profile details will be update via federation following each login event. To preserve the system roles (Application/, Workflow/) assigned previously in the user profile without any changes you need to enable the
Add the following to the
<API-M_HOME>/repository/conf/deployment.toml file and restart the server.
[authentication.framework.extensions] provisioning_handler = "org.wso2.carbon.identity.application.authentication.framework.handler.provisioning.impl.SystemRolesRetainedProvisionHandler"
Even with SSO enabled, if the users do not have sufficient privileges to access API Publisher/Developer Portal/Admin Portal or any other application, they will not be authorized to access them.
Hence the users who will be JIT provisioned should be assigned the relevant role (Internal/creator, Internal/publisher, Internal/subscriber) for them to be able to successsfully login to API Publisher/Developer Portal/Admin Portal.
For more information on Single Sign-On with WSO2 Identity Server, see SAML 2.0 Web SSO in the WSO2 Identity Server documentation.