• Home
• App Integrations
• Single Sign-On Integrations
• AWS OpenSearch Single Sign-On

Configure AWS OpenSearch Single Sign-On SSO

---

Configure AWS OpenSearch SSO in a few simple steps using this setup guide. miniOrange Single Sign-On (SSO) helps you to log in to AWS OpenSearch and other applications using a single set of credentials. Upon enabling SSO for AWS OpenSearch, a person can securely access AWS OpenSearch in one click without having to enter their username and password again.

With miniOrange AWS OpenSearch SSO, you can:

• Enable your users to automatically login to AWS OpenSearch
• Have centralized and easy access control of the users
• Connect easily with any external identity source like Entra ID (Azure), ADFS, Cognito, etc

miniOrange AWS OpenSearch Single Sign-On (SSO) supports the following flows:

• SP (Service Provider) Initiated Single Sign-On (SSO):
  In this flow, a person tries to login to the service provider (AWS OpenSearch account) directly. The request is redirected to the identity provider for authentication. On successful authentication from the identity provider, the person is given access to the application (AWS OpenSearch account).
• IdP (Identity Provider) Initiated Single Sign-On (SSO):
  In this flow, a person logs in to the identity provider using his credentials. Now the person can access any of the configured service providers (AWS OpenSearch account, etc.) through the identity provider dashboard without having to enter the credentials again.
• Just In Time Provisioning:
  This will automate user account creation and pass information in your applications through identity provider. So, when a new user tries to log in to an authorized app for the first time, they trigger the flow of information from the identity provider to the app that's needed to create their account.

Follow the step-by-step guide given below for AWS OpenSearch Single Sign-On (SSO)

1. Configure AWS OpenSearch in miniOrange

• Login into miniOrange Admin Console.
• Go to Apps and click on Add Application button.



• In Choose Application, select SAML/WS-FED from the application type dropdown.



• Search for AWS OpenSearch in the list, if you don't find AWS OpenSearch in the list then, search for custom and you can set up your application in Custom SAML App.

• Enter Custom Application Name as AWS OpenSearch
• Enter the SP Entity ID or Issuerhttps://<open-search-domain>/.
• Enter the ACS URL https://<open-search-domain>/_dashboards/_opendistro/_security/saml/acs.
• Click on Next to proceed further.



• In the Attribute Mapping tab configure the following attributes as shown in the image below.



• To upload respective app logo for a Custom SAML App, click on Upload Logo tab.



• Click on Save.

To get miniOrange metadata details in order to configure AWS OpenSearch:

• Go to Apps >> Manage Apps.
• Search for your app and click on the select in action menu against your app.
• Click on the Metadata Option under the Select Dropdown to get the miniOrange Metadata details. You can also click on the Show SSO Link to see the IdP initiated SSO link for AWS OpenSearch.



• Here you will see 2 options, if you are using miniOrange to manage your user identities, then copy the metadata details related to miniOrange from (Information required to set miniOrange as IdP), if you required to be authenticated via External IDP's (Okta, Entra ID (Azure), ADFS, OneLogin, Google Workspace) you can get metadata from the 2nd Section as shown below.



• Keep SAML Login URL , SAML Logout URL and click on the Download Certificate button to download certificate which you will require in Step 2.

2. Configure AWS OpenSearch SSO Service

• Log into the AWS OpenSearch console.
• On the AWS OpenSearch Service, click on Domain >> Security Configuration >> then click Edit.



• In Edit Security configuration >> SAML authentication for OpenSearch Dashboards/Kibana >> check the Enable SAML authentication.



• Scroll down and click on Import from XML file and upload the downlaoded metadata file which you will get from previous step.



• Click on Save Changes.
• Here, you will obtain the Service provider entity ID, SP-initiated SSO URL and these values will be verified while configuring miniOrange as IdP in Step 1.

3. Test SSO Configuration

Test SSO login to your AWS OpenSearch account with miniOrange IdP:

Using SP Initiated Login

• Go to your AWS OpenSearch URL, here you will be either asked to enter the username or click on the SSO link which will redirect you to miniOrange IdP Sign On Page.



• Enter your miniOrange login credential and click on Login. You will be automatically logged in to your AWS OpenSearch account.

Using IDP Initiated Login

• Login to miniOrange IdP using your credentials.



• On the Dashboard, click on AWS OpenSearch application which you have added, to verify SSO configuration.





Not able to configure or test SSO?


Contact us or email us at idpsupport@xecurify.com and we'll help you setting it up in no time.

4. Configure Your User Directory (Optional)

miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, Microsoft Entra ID, OpenLDAP, Google, AWS Cognito etc), Identity Providers (like Okta, Shibboleth, Ping, OneLogin, KeyCloak), Databases (like MySQL, Maria DB, PostgreSQL) and many more. You can configure your existing directory/user store or add users in miniOrange.

• Setup miniOrange as IDP
• Setup AD as User Directory
• Setup External IDP

• To add your users in miniOrange there are 2 ways:

1. Create User in miniOrange

2. Bulk Upload Users

1. Create User in miniOrange

• Click on Users >> User List >> Add User.



• Here, fill the user details without the password and then click on the Create User button.



• After successful user creation a notification message "An end user is added successfully" will be displayed at the top of the dashboard.



• Click on Onboarding Status tab. Check the email, with the registered e-mail id and select action Send Activation Mail with Password Reset Link from Select Action dropdown list and then click on Apply button.



• Now, Open your email id. Open the mail you get from miniOrange and then click on the link to set your account password.
• On the next screen, enter the password and confirm password and then click on the Single Sign-On (SSO) reset password button.



• Now, you can log in into miniOrange account by entering your credentials.

2. Bulk Upload Users in miniOrange via Uploading CSV File.

• Navigate to Users >> User List. Click on Add User button.



• In Bulk User Registration Download sample csv format from our console and edit this csv file according to the instructions.



• To bulk upload users, choose the file make sure it is in comma separated .csv file format then click on Upload.



• After uploading the csv file successfully, you will see a success message with a link.
• Click on that link you will see list of users to send activation mail. Select users to send activation mail and click on Send Activation Mail. An activation mail will be sent to the selected users.

• Click on Identity Providers >> Add Identity Provider in the left menu of the dashboard



• In Choose Identity Provider, select AD/LDAP Directories from the dropdown.



• Then search for AD/LDAP and click it.



• STORE LDAP CONFIGURATION IN MINIORANGE: Choose this option if you want to keep your configuration in miniOrange. If the active directory is behind a firewall, you will need to open the firewall to allow incoming requests to your AD.
• STORE LDAP CONFIGURATION ON PREMISE: Choose this option if you want to keep your configuration in your premise and only allow access to AD inside premises. You will have to download and install miniOrange gateway on your premise.




• Enter AD/LDAP Display Name and Identifier name.
• Select Directory Type as Active Directory.
• Enter the LDAP Server URL or IP Address against the LDAP Server URL field.
• Click on the Test Connection button to verify if you have made a successful connection with your LDAP server.



• In Active Directory, go to the properties of user containers/OU's and search for the Distinguished Name attribute. The bind account should have minimum required read privileges in Active Directory to allow directory lookups. If the use case involves provisioning (such as creating, updating, or deleting users or groups), the account must also be granted appropriate write permissions.



• Enter the valid Bind account Password.
• Click on the Test Bind Account Credentials button to verify your LDAP Bind credentials for LDAP connection.



• Search Base is the location in the directory where the search for a user begins. You will get this from the same place you got your Distinguished name.



• Select a suitable Search filter from the drop-down menu. If you use User in Single Group Filter or User in Multiple Group Filter, replace the <group-dn> in the search filter with the distinguished name of the group in which your users are present. To use custom Search Filter select "Write your Custom Filter" option and customize it accordingly.



• Click on the Next button, or go to the Login Options tab.
• You can also configure following options while setting up AD. Enable Activate LDAP in order to authenticate users from AD/LDAP. Click on the Next button to add user store.




Here's the list of the attributes and what it does when we enable it. You can enable/disable accordingly.

Attribute	Description
Activate LDAP	All user authentications will be done with LDAP credentials if you Activate it
Fallback Authentication	If LDAP credentials fail then user will be authenticated through miniOrange
Enable administrator login	On enabling this, your miniOrange Administrator login authenticates using your LDAP server
Show IdP to users	If you enable this option, this IdP will be visible to users
Sync users in miniOrange	Users will be created in miniOrange after authentication with LDAP



• Click on the Next button, or go to the Attributes tab.

Attributes Mapping from AD

• By default userName, firstName, lastName, email are configured. Scroll down and click on Save button. To fetch additional attributes from Active Directory, enable Send Configured Attributes. On the left side, enter the name that you wish to release to the applications. On the right side, enter the attribute name from Active Directory. E.g., if you wish to fetch company attribute from Active Directory, and send it as organization to configured applications, enter the following:

  Attribute Name sent to SP = organization
  Attribute Name from IDP = company






• Click on the Next button, or go to the Provisioning tab.

User Import and Provisioning from AD

• If you want to set up provisioning, click here for detailed information. We will skip this step for now.

Test Connections

• You will see a list of directories under Identity Providers. From the dropdown, select AD/LDAP Directories, search for your configured directory, click the three dots next to it, and select Test Connection.



• A pop-up appears prompting you to enter a username and password to verify your LDAP configuration.



• On Successful connection with LDAP Server, a success message is shown.

Test Attribute Mapping

• You will see a list of directories under Identity Providers. From the dropdown, select AD/LDAP Directories, search for your configured directory, click the three dots next to it, and select Test Attribute Mapping.



• A pop‑up appears to enter a username and click Test.



• The Test Attribute Mapping Result will be displayed.

Set up AD as External Directory configuration is complete.

Note: Refer our guide to setup LDAP on windows server.

miniOrange integrates with various external user sources such as directories, identity providers, and etc.

• Okta
• ADFS
• Ping
• AWS Cognito
• Many more

Not able to find your IdP or Need help setting it up?

Contact us or email us at idpsupport@xecurify.com and we'll help you setting it up in no time.

5. Adaptive Authentication with AWS OpenSearch

A. Restricting access to AWS OpenSearch with IP Configuration

You can use adaptive authentication with AWS OpenSearch Single Sign-On (SSO) to improve the security and functionality of Single Sign-On. You can allow a IP Address in certain range for SSO or you can deny it based your requirements and you can also challenge the user to verify his authenticity. Adaptive authentication manages the user authentication bases on different factors such as Device ID, Location, Time of Access, IP Address and many more.

You can configure Adaptive Authentication with IP Blocking in following way :

• Login to Self Service Console >> Adaptive Authentication >> Add Policy.



• Add a Policy Name for your Adative Authentication Policy.
• Select Action for Behavior Change, click the Edit link, and then choose the appropriate Action and Challenge Type for the user from that section.





Action for behavior Change Options :




Attribute	Description
Allow	Allow users to authenticate and use services if Adaptive authentication condition is true.
Deny	Deny user authentications and access to services if Adaptive authentication condition is true.
Challenge	Challenge users with one of the three methods mentioned below for verifying user authenticity.




Challenge Type Options :




Attribute	Description
User second Factor	The User needs to authenticate using the second factor he has opted or assigned for such as OTP over SMS PUSH Notification OTP over Email and, many more.
KBA (Knowledge-based authentication)	The System will ask the user for 2 of 3 questions he has configured in his Self-Service Console. Only after the right answer to both questions is the user allowed to proceed further.
OTP over Alternate Email	User will receive an OTP on the alternate email they have configured through the Self Service Console. Once the user provides the correct OTP, they are allowed to proceed further.



• Now click Edit option from the IP Configuration section to configure custom IP range.
• Select Add IP if the User's IP Address is not in the configured list.
• Specify the IP Address that you want to whitelist. For the IP Range other than the whitelisted one, you can select the above setting to reflect.
• Choose either allow or deny by selecting the corresponding option from the dropdown.
• If a user tries to login with the whitelisted IP address, they will always be allowed access.
• We support IP address range in three formats i.e., IPv4, IPv4 CIDR, and IPv6 CIDR. You can choose whichever is suitable for you from the dropdown menu.
• You can add multiple IPs or IP ranges by clicking the + Add IP button.



• Once the changes are made, scroll down to the end and click on Save.

B. Adaptive Authentication with Limiting number of devices

Using Adaptive Authentication you can also restrict the number of devices the end user can access the Services on. You can allow end users to access services on a fixed no. of devices. The end users will be able to access services provided by us on this fixed no. of devices.

You can configure Adaptive Authentication with Device Restriction in following way


• Login to Self Service Console >> Adaptive Authentication >> Add Policy.
• Add a Policy Name for your Adaptive Authentication Policy.
• Select your Action for behavior Change and Challenge Type for user from the Action for behavior Change Section.



• On the Add Policy tab, go to the Device Configuration section and click the Edit button.
• Enter the Number of Device Registrations Allowed as per your requirement. (2-3 devices are recommended.)
• Choose Action if number of devices exceeded (This will override your setting for Action for behavior Change.)
• Challenge: The user needs to verify himself using any of the three methods mentioned in table in step 5.1
• Deny : Deny users access to the system
• Enable Mobile Device Restriction to block logins from mobile devices. This ensures all login attempts from mobile devices will be declined.
• Enable MAC Address Based Restriction if you want to restrict access based on device MAC address.



• Scroll down to the bottom of the page and click on Save.

C. Add Adaptive Authentication policy to AWS OpenSearch

• Login to Self Service Console >> Policies >> Add Login Policy.
• Click on Edit icon option for predefined app policy.



• Set your policy in the Policy Name and select Password as First Factor.
• Enable Adaptive Authentication on Edit Login Policy page and select the required restriction method as an option.
• From Select Login Policy dropdown select the policy we created in last step and click on Submit.

D. Notification and Alert Message.

This section handles the notifications and alerts related to Adaptive Authentication. It provides the following options :

• Get email alerts if users login from unknown devices or locations: Admins need to enable this option to enable receiving alerts for different alert options.
  
  
  

Option	Description
Users login from unknown IP addresses, devices or locations	Enabling this option allows you to login from unknown IP addresses or devices and even locations.
Number of Device registrations exceeded allowed count	This option will allow you to register more devices than the devices you have numbered.
Challenge Completed and Device Registered	Enabling this option allows you to send an email alert when an end-user completes a challenge and registers a device.
Challenge Completed but Device Not Registered	Enabling this option allows you to send an email alert when an end-user completes a challenge but do not registers the device.
Challenge Failed	Enabling this option allows you to send an email alert when an end-user fails to complete the challenge.




• Next subsection is Send email alerts which allows us to enable or disable alerts for admin and end-users. To enable alerts for admins, you can enable the Administrators checkbox.



• In case you want multiple admin accounts to receive alerts, then you can enable the option for admin and then enter the admin emails separated by a ‘,’ in the input field next to Administrator’s email to receive alerts label. To enable alerts for the end users, you can enable the End User checkbox.
• In case you want to customize the deny message that the end user receives in case his authentication is denied due to adaptive policy, you can do this by entering the message inside Deny Message text box.

How to add a trusted Device

• When End-user log in to the self service console after the policy for device restriction is on, he is provided the option to add the current device as a trusted device.

Troubleshooting

Frequently Asked Questions (FAQs)

External References

• Login into AWS OpenSearch SSO
  
• What is Single Sign-On (SSO)?
  
• Explore Other Integrations