Skip to content

Add federated login

WSO2 Identity Server lets you add and configure external Identity Providers (IdP) so that users can bring their identities in these external IdPs and log in to applications. Follow the guides below to learn how you can integrate the external IdP of your choice with WSO2 Identity Server.

Create a connection

You can register an external IdP in WSO2 Identity Server by creating a connection. WSO2 Identity Server supports a variety of connections for your convenience. Select your preferred connection and follow the guide to learn how to configure it.

Configure JIT provisioning

When a user logs in with an external identity provider using the same email address registered in a local account, JIT-provisioning overrides the attributes of the local account with the attributes received from the external identity provider.

WSO2 Identity Server, by default, disables Just-In-Time (JIT) user provisioning for your external identity provider.

To enable JIT-provisioning,

  1. On the WSO2 Identity Server Console, click Connections and select the relevant connection.

  2. Go to the Just-in-Time Provisioning tab of the selected connection.

  3. Check/Uncheck the Just-in-Time (JIT) User Provisioning checkbox to enable/disable it.

    enable/disable JIT user provisioning

  4. Click Update to save the changes.

Note

Add groups to a connection

To add groups to a connection on WSO2 Identity Server:

  1. On the WSO2 Identity Server Console, go to Connections.
  2. Select your connection and go to the Groups tab.

    Note

    Note that the Groups tab is only available for enterprise, social login and custom connections.

  3. Enter the name of the connection's group attribute you wish to map to the group attribute of WSO2 Identity Server.

    Add the group attribute

  4. Click Update.

  5. Click + New Group and enter the group name. Ensure that the name matches the configuration in the federated connection.

    Add group

  6. Click Finish to add the group information.

Add connections to federation hub

Federation hub is a collection of multiple IdPs configured on WSO2 Identity Server. On the federation hub, each IdP is recognized by the home realm identifier of the IdP.

The following diagram illustrates an authentication flow involving a federated hub. fed-hub-home-realm-identifier

Note

On the application's login page, you can support either local and federated authentication or just federated authentication. This can be done by setting the proxy_mode configuration to one of the following modes:

smart Allow both local and federated authentication
dumb Allow only federated authentication. The home realm identifier must be configured to operate in this mode.
If it is not configured, a separate screen should be displayed to get it from the user.
Configure the proxy_mode by opening the deployment.toml file in the <IS_HOME>/repository/conf directory and setting one of the above modes as follows.

[authentication] 
proxy_mode="smart"

To add a connection to federation hub,

  1. On the WSO2 Identity Server Console, click Connections and select the relevant connection.

  2. Go to the Advanced tab of the selected connection.

  3. Turn on the Federation Hub toggle to add the connection.

  4. Enter the Home Realm Identifier. This value is an identifier used when your application uses a federated IdP. If a user selects this IdP and sends an authentication request, the fidp query parameter will be populated with this value. (example: fidp = googleIdP)

  5. Click Update to save the changes.

Delete a connection

Before you begin

If your connection has applications associated with it, you will not be able to delete the connection.

Before deleting such connections:

  1. Check the associated applications from the Connected Apps tab of the connection.
  2. Click on an application that uses the connection and you will be redirected to the Login Flow tab of the respective application.
  3. Remove the connection from the sign-in flow of the associated applications.
  4. Repeat steps 2 and 3 for all listed applications.
  5. Proceed to delete the connection.

To delete a connection:

  1. On the WSO2 Identity Server Console, go to Connections.
  2. Click Set up and navigate to the General tab.
  3. At the bottom of the page, click the button in the Delete connection.

    Note

    You cannot delete connections that are available by default.

  4. Select the checkbox and confirm your action.

    Delete connection