Keycloak Login using SAML Single Sign On | SSO with Keycloak as SAML IDP

In the SAML SSO plugin for WordPress, go to the Service Provider Setup tab of the plugin. There are two ways to configure the SSO Plugin for WordPress:

A. By uploading IDP metadata:

• Click on Upload IDP metadata button.
• Enter the Identity Provider Name
• You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.
• In the Premium plugin, you can enable auto-sync for the metadata URL which will auto-update the plugin configuration as per the IDP metadata after a set interval of time

B.Manual Configuration:

• Provide the required settings (i.e. Identity Provider Name, IDP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.
• Click on Test configuration to check the attributes and values sent by IDP.

• In the Premium Plugin, you can provide the SAML Logout URL to achieve Single Logout on your WordPress site.

Step 3: Attribute Mapping

• Attribute Mapping feature allows you to map the user attributes sent by the IDP during SSO to the user attributes at WordPress.
• In SAML Plugin for WordPress, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.

• Custom Attribute Mapping: This feature allows you to map any attribute sent by the IDP to the usermeta table of WordPress.

Step 4: Role Mapping

This feature allows you to assign and manage roles of the users when they perform SSO. Along with the default WordPress roles, this is compatible with any custom roles as well.

• From the Attribute Mapping section of the plugin, provide a mapping for the field named Group/Role. This attribute will contain the role related information sent by the IDP and will be used for Role Mapping.
• Navigate to role mapping section and provide the mappings for the highlighted roles.

• For example, If you want a user whose Group/Role attribute value is wp-editor to be assigned as an Editor in WordPress, just provide the mapping as wp-editor in the Editor field of Role Mapping section.

Step 5: SSO Settings

In the Premium plugin you can enable SP-initiated SSO using the following options.

• Auto-Redirection from site: If this option is enabled, any unauthenticated user trying to access your site will get redirected to the IDP login page and after successful authentication they will be redirected back to the same page on your site which they were trying to access.

Steps:

• Go to Redirection and SSO Links tab of the plugin and navigate to Option 1 : Auto-Redirection from site.
• Enable Redirect to IDP if user not logged in [PROTECT COMPLETE SITE] option.



• Auto-Redirection from WordPress Login: If this option is enabled, any unauthenticated user trying to access the default WordPress login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the WordPress site.

Steps:

• Go to Redirection and SSO Links tab of the plugin and navigate to Option 2: Auto-Redirection from WordPress Login.
• Enable Redirect to IDP from WordPress Login Page option.




NOTE: Please enable the Backdoor login and note down the backdoor URL. This will allow you to access the WordPress login page in case you get locked out of the IDP login.



• Login Button: You can add a customized login button anywhere on your site or WordPress login page by navigating to Option 3: Login Button section of Redirection and SSO Links tab.

• SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Option 4: SSO Links section of Redirection and SSO Links tab.