Guide to Configure OpenAM as IDP and WordPress as SP

WordPress SAML SP Single Sign-On plugin gives the ability to enable SAML Single Sign-On for your Wordpress sites. Our plugin is compatible with all the SAML compliant Identity providers. Here we will go through a step-by-step guide to configure SSO between Wordpress site and OpenAM by considering OpenAM as IdP.

miniorange img Pre-requisites : Download And Installation

To configure ForgeRock OpenAM as SAML IdP with Wordpress, you will need to install the miniOrange WP SAML SP SSO plugin:

Step 1: Setup OpenAM as Identity Provider

All the information required to configure OpenAM as IdP i.e. plugin’s metadata is given in the Service Provider Info tab of the miniOrange plugin.

Create OpenAM as a Hosted Identity Provider

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.

WordPress Single Sign-On (SSO)SAML upload metadata

Login to the OpenAM admin console.
From the REALMS page, select the realm under which you want to create the SAML application. You will be redirected to the Realm overview page.
Click on Create SAMLv2 Providers in the Realm Overview page.
Click on Create Hosted Identity Provider. You will be redirected to the configuration page.
Configure SAML IDP as given below:
- Name: Name of the SAML IDP
- Signing Key: Select the Signing key from the dropdown.
- New Circle of Trust: Provide a name of the groups of IDP and SP that trust each other.
- Attribute Mapping: Configure user profile attributes to be sent to the Service Provider application.
Click on the Configure button on the top right corner.

SAML Single Sign-On (SSO) using OpenAM Identity Provider (IdP),Create SAMLv2 IdP on server

Configure Remote Service Provider

Go to OpenAM admin dashboard and open Realm Overview page.
Click on Create SAMLv2 Providers.
Now click on Register Remote Service Provider. You will be redirected to the configuration page.
Configure the Service Provider as given below:
- Where does the metadata file reside: URL
- URL of metadata: Paste the miniOrange plugin’s Metadata URL here. You can get it from the Service Provider Metadata tab
- Circle of Trust: Add to existing
- Existing Circle of Trust: Select the Circle of Trust (group) in which your hosted IDP is located
- Attribute Mapping: Configure user profile attributes for mapping.
Click on the Configure button on the top right corner and then click on OK button.

Verify the configuration of IdP and SP from the Federation tab of OpenAM.
You can download the OpenAM IdP metadata using the URL given below.
- For Single Realm: [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp
- For Multiple realms:
  [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp?entityid=[IdPentityID]&realm=/realmname
Keep the IDP Metadata handy as it will be used in configuring the miniOrange Plugin.

Step 2: Configuring WordPress as SP

We will go through the steps to setup WordPress as a Service Provider. Here, we will be adding the IdP metadata to configure the plugin.

Free

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.

Standard

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

In the standard 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 Standard 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:

Option 1: Auto- Redirection from site

Redirect to IdP if user not logged in [PROTECT COMPLETE SITE]

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:

Option 2: Auto- Redirection from WordPress Login

Redirect to IdP from WordPress Login Page

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.

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

Premium

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

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:

Option 1 : Auto-Redirection from site

Redirect to IdP if user not logged in [PROTECT COMPLETE SITE]

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:

Option 2: Auto- Redirection from WordPress Login

Redirect to IdP from WordPress Login Page

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.

Recommended Add-ons

SCIM User Provisioning

SCIM User Provisioning allows you to sync user's creation, updation and deletion from your IDP to WordPress site

Know more

Page and Post Restriction

Page and Post Restriction plugin restricts WordPress pages and posts based on User Roles and User's Login Status

Know more

BuddyPress Integrator

Allows to integrate user attribute information received from SAML Identity Provider with the user's BuddyPress profile

Know more

Learndash Integrator

LearnDash Integration will map the SSO users to LearnDash groups as per the user group attributes sent by your Identity Provider

Know more

Attribute Based Redirection

Attribute Based Redirection plugin can be used to restrict and redirect users to different URL's based on SAML attributes

Know more

Federation Single Sign On

Federation SSO allows configuring Single Sign-On (SSO) support for multiple IDPs and authenticating with different IDPs using SAML protocol

Know more

SAML Single Sign-On (SSO) for WordPress using OpenAM as IDP | OpenAM SSO

Step 1: Setup OpenAM as Identity Provider

Step 2: Configuring WordPress as SP

Free

Step 3: Attribute Mapping

Step 4: Role Mapping

Step 5: SSO settings

Standard

Step 3: Attribute Mapping

Step 4: Role Mapping

Step 5: SSO settings

Steps:

Steps:

Premium

Step 3: Attribute Mapping

Step 4: Role Mapping

Step 5: SSO settings

Steps:

Steps:

Recommended Add-ons

SCIM User Provisioning

Page and Post Restriction

BuddyPress Integrator

Learndash Integrator

Attribute Based Redirection

Federation Single Sign On

SSO Login Audit

Other Add-ons

Additional Resources

Contents

Why Our Customers choose miniOrange WordPress Single Sign-On (SSO) Solutions?

24/7 Support

Customer Reviews

Extensive Setup Guides

STAY CONNECTED

Product

Solutions

Why miniorange

Company