Step 1: Setup Jboss Keyclock as Identity Provider
Follow the steps below to configure Jboss Keyclock as an Identity Provider
Setup IDP
- In the miniOrange SAML SP SSO plugin, navigate to Service Provider Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the Identity Provider.
- In your Keycloak admin console, select the realm that you want to use.
- Click on the Clients from the left nav bar.
- Create a new client/application.
- Configure the following:
- Under Fine Grain SAML Endpoint Configuration, configure the following:
- Click on Save.
| Client ID | The SP-EntityID / Issuer from the step 1 of the plugin under Configure IDP tab. |
| Name | Provide a name for this client |
| Description | Provide a description |
| Enabled | ON |
| Consent Required | OFF |
| Client Protocol | SAML |
| Include AuthnStatement | ON |
| Sign Documents | ON |
| Optimize Redirect signing key lookup | OFF |
| Sign Assertions | ON |
| Signature Algorithm | RSA_SHA256 |
| Encrypt Assertion | OFF |
| Client Signature Required | OFF |
| Canonicalization Method | EXCLUSIVE |
| Force Name ID Format | ON |
| Name ID Format | |
| Root URL | Leave empty or Base URL of Service Provider |
| Valid Redirect URIs | The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under configure IDP tab. |
| Assertion Consumer Service POST Binding URL | The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under Configure IDP tab. |
| Logout Service Redirect Binding URL | The Single Logout URL from the step 1 of the plugin under Configure IDP tab. |
Add Mappers
- Add the following attributes in the Mappers tab.
- Click on Add Built-in and add the following option.
Download setup file
- In the Installation Tab, choose SAML Metadata IDPSSODescriptor as Format option.
- Download it and keep it handy. It will be used to configure the plugin.
×
![]()
Step 2: Configuring WordPress as SP
In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:
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.
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.
Step 3: Attribute Mapping
- In the free plugin, only NameID is supported for Email and Username attributes of the WordPress user.
- When a user performs SSO, the NameID value sent by the IDP will get mapped to the email and username of the WordPress user.
Step 4: Role Mapping
- In the free plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO.
- Go to Attribute/Role mapping tab and navigate to Role Mapping section.
- Select the Default Role and click on the Save button.
Step 5: SSO settings
- In the free plugin you can add a login widget to enable SP-Initiated SSO on your site.
- Navigate to Redirection and SSO links tab and follow the given steps given under Option 1: Use a Widget to add a login widget on your site.
In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:
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.
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.
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 WordPress SAML plugin, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.
NOTE: If you click on Test Configuration button in Service Provider Setup tab and authenticate with your IDP, you can see a list of attributes sent by the IDP in the Attribute/Role mapping tab. This information can be used to provide the above mapping.
Step 4: Role Mapping
- Go to Attribute/Role mapping tab and navigate to Role Mapping section.
- Select the Default Role and click on the Save button.
In the standard plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO.
Step 5: SSO settings
- 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.
- 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.
- SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Redirection and SSO Links tab > Option 3: SSO Links section of the plugin
In the Standard plugin you can enable SP-initiated SSO using the following options.
Steps:
-
1. Go to Redirection and SSO Links tab of the plugin and navigate to Option 1: Auto- Redirection from site.
2. Enable Redirect to IdP if user not logged in [PROTECT COMPLETE SITE] option.
Steps:
-
1. Go to Redirection and SSO Links tab of the plugin and navigate to Option 2: Auto- Redirection from WordPress Login.
2. 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.
In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:
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.
- 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 WordPress SAML plugin, 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
- 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.
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.
Step 5: SSO settings
- 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.
- 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.
- 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.
In the Premium plugin you can enable SP-initiated SSO using the following options.
Steps:
-
1. Go to Redirection and SSO Links tab of the plugin and navigate to Option 1 : Auto-Redirection from site.
2. Enable Redirect to IdP if user not logged in [PROTECT COMPLETE SITE] option.
Steps:
-
1. Go to Redirection and SSO Links tab of the plugin and navigate to Option 2: Auto- Redirection from WordPress Login.
2. 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.
If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com