Magento Okta Single Sign-On (SSO) | SSO into Magento using Okta Credentials

Overview

The Okta Magento SSO enables secure and seamless login to your Magento by using Okta as your OAuth and OpenID Connect provider. With Okta Magento login, users can access the store using OKTA login credentials. This means with our extension, users of your Okta organization/directory can login into your Magento store using their okta login cedentials. Our Magento Okta Login extension provides secure Single Sign-On (SSO) integration with advanced features like attribute mapping, role mapping, and access control. It enhances site security by ensuring that only verified users can log in or register your Magento site. With a simple Magento Okta SSO setup process, the plugin streamlines user authentication and improves overall access management. Follow the guide below to install and configure Okta Magento SSO effortlessly. Click here to read more about the Magento OAuth Single Sign-On (OAuth & OpenID Connect Client) extensions extra features.

Installation Steps

• Using Composer
• Manual Installation

• Purchase the miniOrange Magento OAuth Single Sign-On (SSO) extension from Magento Marketplace (Adobe Commerce Marketplace).
• Go to My profile -> My Purchases
• Please ensure you are using correct access keys (My Profile - Access Keys)
• Paste the access keys in your auth.json file inside your project
• Use the below command to add the extension to your project.

  "composer require {module_name}:{version}"

• You can see the module name and list of versions in the selector below the extension module name.
• Run the following commands on command prompt to enable the extension.

php bin/magento setup:upgrade

• Download the miniOrange Magento OAuth Single Sign-On (SSO) extension.
• Unzip all contents of the zip inside the MiniOrange/IDPSaml directory.

{Root Directory of Magento} app code MiniOrange OAuth

• Run the following commands on command prompt to enable the extension

php bin/magento setup:upgrade

Configuration Steps

1. Setup Okta as OAuth Provider for Magento SSO Okta Login

• First of all, go to https://www.okta.com/login and log into your Okta account.
• Go to the Okta Admin panel. Go to Applications -> Applications.

• You will get the following screen. Click on Create App Integration button.

• Select sign in method as the OIDC - OpenID Connect option and select Application type as web application, click on Next button.

• You will be redirected to the app details page. Enter App integration name and Sign-in redirect URIs. you will get that from miniOrange Magento SSO (OAuth/OIDC) 'OAuth Provider' tab under the Redirect/Callback URL field.

• Scroll down and you will see the Assignments section. Choose a controlled access option and uncheck the Enable immediate access with Federation Broker Mode option. Click on Save button.

• Now you will get the Client credentials and Okta domain. Copy these credentials in Miniorange Magento SSO (OAuth/OIDC) extension configuration on corresponding fields.

Note: Enter https:// in the Okta domain field in the Magento Okta SSO extension which you will get from General Settings. eg.( https://dev-32414285.okta.com ).







1.1 Assign an app integration to a user

• Go to Applications tab and Click on your application.

• Select the Assignments tab.

• Click Assign and select Assign to People.
• If you want to assign the application to multiple users at the same time then select Assign to Groups [If an app is assigned to a group then, the app will be assigned to all the people in that group]

• Click Assign next to a user name.

• Click Save and Go Back.

• Click Done.




1.2 Profile Attributes for the id Token

• In your Okta admin dashboard, navigate to Security -> API.

• Select your SSO application and click on the edit icon.

• Go to claims tab and select the ID token option.

• click on Add claim button.

• Give a Name to your claim/attribute and Select ID Token from the token type dropdown. Now, enter the value user.$attribute in the Value field based on the attribute you want to receive. Keep other settings as default and click on Create button.

• Follow the similar steps for all the attributes you want to see. You will have a list similar to the below one.

• You will be able to see the attributes in the Test Configuration output as follows.



You've successfully set up Okta Magento - Single Sign-On (SSO) using Okta as the OAuth Provider, allowing users to log in to your Magento Okta Login - site securely with their Okta login credentials.

2. Setup Magento as OAuth Client

• After successfully configuring OAuth Provider, go to OAuth Providers tab and click on Add Provider button.

• Now, Enter the OAuth Provider Name, Client ID, Client Secret, Scope and provided endpoints.
• Please refer the Endpoints table provided below to authorize Single Sign-On (SSO) with Okta to your Magento site.

Scope:	openid email profile
Authorize Endpoint:	https://{yourOktaDomain}.com/oauth2/default/v1/authorize
Access Token Endpoint:	https://{yourOktaDomain}.com/oauth2/default/v1/token
Get User Info Endpoint:	https://{yourOktaDomain}.com/oauth2/default/v1/userinfo
Custom redirect URL after logout:[optional]	https://{yourOktaDomain}.com/login/signout?fromURI= <your url>




Note: Please try the following endpoints if you receive a 404 Server error from Okta at the time of SSO.

Authorize Endpoint:	https://{yourOktaDomain}.com/oauth2/v1/authorize
Access Token Endpoint:	https://{yourOktaDomain}.com/oauth2/v1/token
Get User Info Endpoint:	https://{yourOktaDomain}.com/oauth2/v1/userinfo

• Click on the Save button to save the settings.
• Click on the Test Configuration button.

• You will see all the values returned by your OAuth Provider to Magento in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.




Note: In the Enterprise Version of the extension you can setup multiple providers. To setup a different provider click on the Add Provider button and setup your required provider. You can find the setup guides of all the providers from here.

3. Multisite Settings (*Available in the Enterprise versions)

• Navigate to Multisite Settings tab. Here you can all the subsites under your Magento Installation where you wish to enable the SSO. You can check the checkbox against all the subsites and click on save.
• You would also see the Callback URL for each subsite which you can use to setup the required OAuth Provider.


4. Sign-In Settings

• Navigate to Sign-in Settings tab and Choose the OAuth Provider from the dropdown menu to proceed with the configuration.
• Here you find the option the enable the login link on Admin*/Customer Login Page (*Admin SSO is available in the premium versions)

• You can automatically create Admin and Customer users during SSO if they don't already exist. Simply enable the corresponding checkbox to activate.

• The Premium extension also provides you the the feature to auto redirect your user to the IdP Login Page if the user is not already logged in.

• If you want to initate SSO from any page you can also use the SSO link provided in the extension.

5. Customer / Admin SSO

• Customer Single Sign-On (Customer SSO)
• Admin Single Sign-On (Admin SSO)

• Go to customer login page and you will see the SSO button on your frontend. Click on the button and test the SSO.

• You will be sucessfully logged in into Magento.

• Visit your admin login page and you will see the SSO button on your admin page. Click on the button to initate SSO as an admin.

• After sucessfully logged into magento as admin you will be redirect to magento backend dashboard.

6. Headless SSO Settings (*Available in the premium versions)

• Navigate to Sign-in Settings tab. Here you find the option the enable the SSO for your Headless Magento Store.

• Paste your Frontend Post URL in the given field. You should enter your frontend store URL here.

Attribute / Custom Mapping(Optional). *This is Premium feature.

1.1: Attribute Mapping (Optional).

• Attributes are user details that are stored in your Identity Provider.
• Attribute Mapping helps you to get user attributes from your Identity Provider (IdP) and map them to Magento user attributes like firstname, lastname etc.
• While auto registering the users in your Magento site these attributes will automatically get mapped to your Magento user details.
• Only NameID can be mapped to Magento's Email and Username characteristics with the free plugin. Multiple user attributes from the IdP, on the other hand, can be mapped to Magento attributes in the premium version of the plugin. You can map custom attributes that you've added to your IdP in addition to the default attributes.
• When a user performs SSO, the NameID value sent by the IdP will get mapped to the email and the username of the Magento user.

Username:	Name of the username attribute from IdP (Keep NameID by default)
Email:	Name of the email attribute from IdP (Keep NameID by default)
Group/Role:	Name of the Role attribute from Identity Provider (IdP)

• You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.

1.2: Custom Attribute Mapping (Optional). *This is Premium feature.

• In the Enter Attribute Name field enter the Attribute Name you wish to map against the attribute you are receiving from your Identity Provider.
• Click on Add button
• Now, Enter the attribute name your are receiving from your Identity Provider in the provided field.
• Click on save button for saving the configuration.
• You can also delete the configuration by entering the name in attribute name field and then click on delete button.

Role Mapping (Optional). *This is Premium feature.

• Magento uses a concept of Roles, designed to give the site owner the ability to control what users can and cannot do within the site. Role mapping helps you to assign specific roles to users of a certain group in your IdP.
• While auto registering, the users are assigned roles based on the group they are mapped to.
• You can specify a default role in the POC extension that will be allocated to all non-admin users when they conduct SSO.
• Select the Default Role which you want to assign to all the non-admin users and click on the Save button.

• You also have the ability to Update the Backend/Frontend Roles on SSO in the premium extension.
• You can also specify a default role that will be allocated to all non-admin users when they conduct SSO in the premium extension.
• Select the Default Role which you want to assign to all the admin users and click on the Save button.


Additional Resources

• Magento Security Solutions
• What is Single Sign-On (SSO) Login?
• Okta's developer documentation for OAuth 2.0 & OpenID Connect
• Seamless Okta WordPress SSO Integration: Learn About Okta and OAuth
• Magento OAuth Single Sign On (SSO) Plugin.

Get in Touch

Please reach out to us at magentosupport@xecurify.com, and our team will assist you with setting up the Magento 2 SSO (OAuth/OIDC) Extension. Our team will help you to select the best suitable solution/plan as per your requirement.