Search Results :

×
Sign Up Contact Us

Contents

Guide to Configure ASP.NET Framework SAML SSO using CyberArk as IDP

ASP.NET SAML Single Sign-On (SSO) module gives the ability to enable SAML Single Sign-On for your ASP.NET applications. Using Single Sign-On you can use only one password to access your ASP.NET application and services. Our module is compatible with all the SAML compliant identity providers. Here we will go through a step-by-step guide to configure Single Sign-On (SSO) between ASP.NET and CyberArk considering CyberArk as IdP.

download plugin button Download Plugin plugin pricing button plugin pricing button Pricing Plans

Platform Support: The ASP.NET SAML SSO module supports ASP.NET 3.5 and above frameworks.


  • To install the miniOrange SAML SSO NuGet package in your .NET application, simply install the miniOrange NuGet package on top of your application.
NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.SAML.SSO

  • After Installation, open your browser and browse the module dashboard with the URL below:
 http(s)<your-dotnet-application-base-url>?ssoaction=config
  • If the registration page or login page pops up, you have successfully added the miniOrange SAML SSO module in your application.
ASP.NET Core- registeration page

  • Register or log in with your account by clicking the Register button to configure the module.
  • After successful registration, you will receive a trial license key on your registered email address.
  • To activate the module, you can either:
    • Enter the license key received via email in the provided input field.

    OR

    • Upload the license file that you downloaded by clicking on the Click Here button.
ASP.NET Framework Verify Trial License

  • Then, check the box "I have read the above conditions and I want to activate the module", and click the Activate License button.
ASP.NET Framework Activate License

There are two ways detailed below with which you can get the SAML SP metadata to configure onto your Identity Provider end.

A] Using SAML metadata URL or metadata file

  • In the Plugin Settings menu, look for Service Provider Settings. Under that, you can find the metadata URL as well as the option to download the SAML metadata.
  • Copy metadata URL or download the metadata file to configure the same on your identity provider end.
  • You may refer to the screenshot below:
ASP.NET Core- Service Provider Metadata

B] Uploading metadata manually

  • From the Service Provider Settings section, you can manually copy the service provider metadata like SP Entity ID, ACS URL, Single Logout URL and share it with your identity provider for configuration.
  • You may refer to the screenshot below:
ASP.NET Core- enter sp data manually
  • Login with your CyberArk Administrator credentials.
CyberArk Administrator

  • Navigate to the Web Apps under Apps.
Web Apps

  • Click on Add Web Apps.
Add Web Apps

  • Click on Custom button, select SAML app and click on Add.
Add Web Apps

  • Click on Yes to add SAML app.
Add Web Apps

  • Under Settings, enter the following:
Name Enter a label for Service Provider.
Description Enter description for your application.
Logo Enter logo for your application.
Add Web Apps

  • Click on Trust and click on the Download Metadata File keep the downloaded file handy as it will be used in the later steps.
Download Metadata File

  • Click on Choose File to upload the Metadata file downloaded from your Service Provider Settings tab (ASP.NET) and click on Save.
  • To get the Metadata, go to the Service Provider Settings tab in the miniOrange SAML plugin. And copy the Metadata URL Or Download the Metadata xml file.
Upload Metadata File

  • To assign user to your application, click on Permissions and click on Add.
To assign user

  • Search for User, Group, or Role to assign user for the application and perform SSO.
User, Group, or Role

  • Click on Add button.

  • Click on the Select your IDP button to configure a new Identity Provider.
ASP.NET Framework SAML SSO using CyberArk as IDP - Add New IDP

  • Under the Plugin Settings tab, select CyberArk as your identity provider from the list shown.
ASP.NET Core SAML SSO using CyberArk as IDP - Add New IDP

There are two ways detailed below with which you can configure your SAML Identity Provider metadata in the module.

A] Upload metadata using the Upload IDP Metadata button:

  • If your identity provider has provided you with the metadata URL or metadata file (.xml format only), then you can simply configure the identity provider metadata in the module using the Upload IDP Metadata option.
  • Copy metadata URL or download the metadata file to configure the same on your identity provider end.
  • You may refer to the screenshot below:
ASP.NET Framework - Upload IDP Metadata

  • You can choose any one of the options according to the metadata format you have available.

B] Configure the identity provider metadata manually:

  • After configuring your Identity Provider, it will provide you with IDP Entity ID, IDP Single Sign On URL and SAML X509 Certificate fields respectively.
  • Click Save to save your IDP details.
ASP.NET Framework- Configure IDP Manually
  • After uploading the metadata details, navigate to the Identity Provider Settings section. Hover over the Select Actions dropdown and click on Test Configuration.
ASP.NET Core- Test Configuration

  • The screenshot below shows a successful result. Click on SSO Integration to further continue with the SSO Integration.
ASP.NET Framework - Test Configuration

  • If you are experiencing any error on the module end you’ll be shown with the window similar to below.
ASP.NET Framework - Test Configuration Error

  • To troubleshoot the error you can follow the below steps:
  • Under Troubleshoot tab, enable the toggle to receive the plugin logs.
ASP.NET Framework - TroubleShoot

  • Once enabled, you will be able to retrieve plugin logs by navigating to Plugin Settings tab and clicking on Test Configuration.
  • Download the log file from the Troubleshoot tab to see what went wrong.
  • After testing the configuration, Map your application attributes with the Identity Provider (IdP) attributes.
  • From the left-hand menu of the miniOrange ASP.NET SAML SSO Module, click on Attribute/Role Mapping tab as shown in the image.
ASP.NET Framework - Attribute Mapping

  • If you want to pass additional attributes from your IdP, enter the Attribute Name and corresponding Attribute Value under Custom Attribute Mapping.
  • Note: All the mapped attributes will be stored in the session so that you can access them in your application.
  • Once the attributes are mapped, click Save Attribute Mapping to apply changes.
ASP.NET Core- Attribute Mapping
  • This steps allow you to retrieve the SSO user information in your application in the form of session.
  • You can also look the setup tour to understand how the SSO integration would work in your asp.net module application.
  • Just copy-paste that code snippet wherever you want to access the user attributes.
ASP.NET Framework - Integration Code

  • Note: With the trial module the authenticated user details are stored in session variables. Support of setting user claims using Header-based, Forms-Cookie-based, JWT-based authentication is available in our premium plugin.
  • Hover on Select Actions and click on Copy SSO Link.
ASP.NET Framework Copy SSO Link

  • Use the following URL as a link in the application from where you want to perform SSO:
  https://<asp.net-module-base-url>/?ssoaction=login
  • For example, you can use it as:
  <a href="https://<asp.net-module-base-url>/?ssoaction=login">Log in</a>
  • Use the following URL as a link to your application from where you want to perform SLO:
  https://<asp.net-module-base-url>/?ssoaction=logout
  • For example, you can use it as:
  <a href="https://<asp.net-module-base-url>/?ssoaction=logout">Log out</a>

Related Articles


 Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

We'll Reach Out to You at the Earliest!


ADFS_sso ×
Hello there!

Need Help? We are right here!

support