Search
START TYPING AND PRESS ENTER TO SEARCH
Search
START TYPING AND PRESS ENTER TO SEARCH

Single Sign On (SSO) Using API Authentication

miniOrange allows you to authenticate your users via API authentication provider into multiple applications.
This way, you can achieve Single Sign-On (SSO) into your applications where the users will need to authenticate themselves via your API Server only once and they can access all the configured applications.

We support REST API Authentication using API keys.

In API key authentication, a key-value pair is sent to the API Server either in Request headers or in request body.

For application specific guides of Wordpress, Moodle, Magento, refer our IDP Setup Guides.

Step 1: Fetch API endpoint information

  • Note down the User Authentication URL and the API Key Value required for your API endpoint.
    • User Authentication URL Your API Authentication provider URL.
    Eg: https://example.com/endpoint/
    API Key The API key value provided by your API Authentication Provider

Step 2: Setup Custom API authentication source in miniOrange

  • Click here and login with your miniOrange account.
  • Navigate to User Stores and click on the Add User Store button.
    wordpress as api authentication source add user store
  • Switch to the API tab and select Custom API from the dropdown.
    wordpress as api authentication source api configuration
  • Provide an API identifier name.
  • Under the Authentication Configuration section, paste the User Authentication URL that you copied in step 1 above.
  • You can pass API key via two different methods i.e. Request Header or Request Body.

Via Request Header

In this method, The API key is sent as "Authorization_key" via request header. You can refer to the example below.

  • Provide the Header Name Authorization_key and its value i.e. Value of your API key that you copied in step 1.
  • Select the Method as GET.
  • Provide the Authentication Parameters as:
    Authentication Parameters {
    "username":"##username##",
    "password":"##password##"
    }
    Note: Extra parameters can be sent in the Authentication parameters section if required. These parameters are added in the format "parameter-name":"parameter-value".
    • API Authentication Configuration Example with API key in header
  • Provide the Status field’s value as status and Status Message field’s value as message.
    Status Name of field in the server response that contains the status code
    Staus Message Name of the field that gives the description of the status in the response

Via Request Body

In this method, The API key is sent as "api_key" parameter in the POST body as JSON.

To configure your provider to send API key as a field in request body, you can refer below.

  • In the headers section, provide the Header Name Content-Type and its value application/json.
    (The content-type in the header specifies what type of data is actually sent in the request. Some examples of Content-type can be: application/json; text/html; charset=UTF-8; multipart/form-data; text/plain, etc.)
  • Select the Method as POST.
  • Provide the Authentication Parameters as:
    Authentication Parameters {
    "api_key":"value",
    "username":"##username##",
    "password":"##password##"
    }    		 Put the API key value that you copied in step 1 in place of 'value'.
    Note: Extra parameters can be sent in the Authentication parameters section if required. These parameters can be added as fields in request body in the format "parameter-name":"parameter-value".

    • api authentication source user authentication parameters
  • Provide the Status field’s value as status and Status Message field’s value as message.
    Status Name of field in the server response that contains the status code
    Staus Message Name of the field that gives the description of the status in the response
  • (Optional)You can configure extra attributes to be sent from your API source to your service provider. For this, click on the Send Configured Attributes toggle button. You will now be able to see Attribute mapping fields.
    In the first field write the name of the attribute that would be sent to the service provider. In the next field write the name of the attribute that will be received from the API source.
    Attribute Mapping in Rest API Authentication via API Key
  • Click on the Save button.
  • To test the connection, select the user store you just added and click on Test Authorization API.

    api authentication source test authorization api
  • Enter your credentials when prompted and you should be able to see a Success message.

Step 3: Configure Your application in miniOrange

  • With us, You can configure application according to the the protocol it supports like SAML, OAuth, JWT, Ws-fed etc.
  • For example lets say the application supports SAML. Then go with the configurations Shown in SAML Application Tab.

SAML Application

  • Login to miniOrange Admin Console.
  • Go to Apps >> Manage Apps Click Configure Apps button.
    • azure ad saml Apps
  • Then click on SAML tab. Search for Custom App.
    • azure ad saml Apps azure ad saml Apps
  • Get the ACS URL and SP Entity ID from your application.
  • Enter the following values OR click on Import SP Metadata:
    • Service Provider Name Choose appropriate name according to your choice
    SP Entity ID or Issuer Your Application Entity ID
    ACS URL X.509 Certificate (optional) Your Application Assertion Consumer Service URL
    NameID Format  Select urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
    Response Signed Unchecked
    Assertion Signed Checked
    Encrypted Assertion Unchecked
    Group policy Default
    Login Method
  • Click on Save to configure Your applcation.
  • Now to get the IDP metadata of the app configured, Go to apps >> your_app >> select >> metadata tab.
    • azure ad saml Apps
  • Click on the Show Metadata details in the Information required to Authenticate via External IDPs section. Download the metadata XML file by clicking on Download Metadata button or copy the Metadata URL link.
    • azure ad saml Apps
  • You need to Upload this metadata in your application.

OAuth Application

  • To configure OAuth application in miniOrange, login to miniOrange Admin Console.
  • Go to Apps >> Manage Apps Click Configure Apps button.
    • configure app
  • Select on OAuth/OIDC tab. Click on Open ID Connect App .
  • You can add any OAuth Client app here to enable miniOrange as OAuth Server. Few popular OAuth client apps for single sign-on are Salesforce, WordPress, Joomla, Atlassian, etc.
    • OAuth openIDConnect app OAth AddopenIDConnect app
  • Enter following Values:
    • Client Name Add appropriate Name
    Redirect URL Get the Redirect-URL from your OAuth Client
    Descrption Add if required
    Group Name Default
    Policy Name
    Login Method
  • Click on Save
  • Now to provide the required data to OAuth client go to the app configured i.e apps >> your_app >> select >> edit.
    • OAuth editOpenidConnect app OAuth openidConnectData

    Note: Choose the Authorization Endpoint according to the identity source you configure.

  • When you want to use you want to use miniOrange as OAuth identity server use this endpoint: https://{mycompany.domainname.com}/moas/idp/openidsso
  • If you are configuring any Identity Provider in Identity Providers Menu and not using miniOrange as IDP use this endpoint: https://{mycompany.domainname.com}/broker/login/oauth{customerid}

JWT Application

  • Select External/JWT App.
    • External JWT app
  • Configure the name for your application and configure Redirect-URL which tells where to send JWT response. Redirect-URL should be an endpoint on your application where you want to achieve SSO.
    • JWT app configure

    In case you are setting up SSO with Mobile Applications where you can't create an endpoint for Redirect or Callback URL, use below URL.

    https://login.xecurify.com/moas/jwt/mobile
  • Click Save
  • To get the SSO link for your application, Go to Apps >> your_app >> select >> Edit.
    • JWT app SSO
  • Then, copy the Single Sign On Url and verify SSO setup by browsing that url.
    • JWT app SSO
  • On successful authentication, you will be redirected to configured Redirect or Callback URL with JWT token
  • You will need to download a certificate from App > Manage Apps, and click Certificate link against your configured application. This certificate will be used for signature validation of JWT response.
    • JWT app SSO certificate

Step 4: Setup Multiple IDPs (Optional)

    You also have a choice to set multiple IDPS for Single Application. And there are three ways to represent them :

  • Login using IDP selection page: It gives user an option to Select IDP from dropdown list during login time.
  • Domain Mapping: Here we map the email domains to particular IDP. So when the user enters the Email address with specific domain he would be redirected to Respective IDP.
  • App Identity Provider Mapping: gives user an option to select one specific IDP for their application before login.

    • Note :At once you can select either of them.

A] Login using IDP selection page

  • You can configure multiple IDPs (identity providers) and give users the option to select the IDP of their choice to authenticate with.
    For Example - It could be multiple AD domains belonging to different departments or multiple okta organizations.

    • Few usecases where customers configure multiple IDPs -

  • Suppose you have a product which many of your clients use and each client has their own unique IDP so you want them to SSO into your product as well using their existing IDP only. miniOrange provides a centralized way to connect with all IDPs in a very easy manner and integrate SSO into your application.
  • Suppose you are providing a course to many universities, each having a unique IDP like Shibboleth, ADFS, CAS, etc. You can provide single sign-on (SSO) into your course application to all these universities by integrating with all of them using a single platform provided by miniOrange.
  • This is the endpoint to call from your saml application -
    For Cloud IDP - https://login.xecurify.com/moas/discovery?customerId=<customer_id>
    For On-Premise IDP - https://yourdomain.com/discovery?customerId=<customer_id>

    • You can see the screenshot below of the IDP Selection Page with a list of IDPs .

    Note: To view the IDP in drop-down list ,go to Identity Providers tab > against your configured IDP > Select >Edit , here Enable the Show IdP to Users option.

    idp selection

  • You can also change the look and feel of this page. Login to miniOrange Admin console. Navigate to Customization -> Branding Configuration. See the below screenshot for reference-
    customize idp selection
  1. You can customize the title of this page.
  2. You can change the logo and favicon for this page.
  3.  You can change the background and button color for this page from admin UI.

B] Login via Domain Mapping

If you have multiple IDPs and you want a certain set of users to authenticate from one IdP whereas another set of users to authenticate from another IdP, based on their email domains then you can achieve this by using the following steps:- Our domain mapping feature

  • We have provided a Domain Mapping field under each IdP where admins can enter the domain eg. demo.com , example.com as shown in the screenshot below.

    • For your reference , Azure AD and Okta is being used as two different IDPs and WordPress is being used as SP. Follow the guides to set up Okta and WordPress at your end.


  • Once the setup is complete you can login through your Wordpress site.
  • Lets Say in Azure AD IDP Domain field we enter example.com and in Okta IDP Domain field we enter demo.com
  • So a user logging in with the example.com domain will be redirected to Azure AD IDP.
  • User logging in with email address having demo.com domain will be redirected to Okta IDP.
  • Once the user will authenticate itself through respective IDPs, it will be redirected back to Wordpress site.

C] Login via App Identity Provider Mapping

    If you have multiple IDPs (identity provider) and you want a certain application user to authenticate with one IDP and other application users with another IDP then you can achieve this by our Identity Source Feature.

  • Go to apps >> your_app >> select >>edit.

    • edit saml app
  • Here You will have an option called as Identity source.

  • The dropdown list would show the list of configured IDPs (Identity providers) in miniOrange Identity Providers tab and Userstore.

  • Select one IDP you want for this application. Click on Save.

    • saml app identity source option
  • Now the users of this application would be able to authenticate only by the IDP(Identity Provider) selected from Identity Source dropdown list.