NetExam SAML Single Sign-On (SSO)

The following is an overview of the steps required to configure the NetExam Web application for single sign-on (SSO) via SAML.

  1. Prepare NetExam for single sign-on (see NetExam requirements for SSO).

  2. In the Identity Administration portal, add the application and configure application settings.

    Once the application settings are configured, complete the user account mapping and assign the application to one or more roles. For details, see Configure NetExam in the Identity Administration portal (Part 1).

  3. Configure the NetExam application for single sign-on.

    To configure NetExam for SSO, contact NetExam and give them the downloaded metadata file available from the Identity Administration portal Application Settings page. For details, see NetExam SAML Single Sign-On (SSO).

    After you are done configuring the application settings in the Identity Administration portal and the NetExam application, users are ready to launch the application from the Identity User Portal.

  4. Finish configuring application settings in the Identity Administration portal.

Once the application settings are configured, complete the user account mapping and assign the application to one or more roles. For details, see Configure NetExam in the Identity Administration portal (Part 2).

NetExam requirements for SSO

Before you configure the NetExam web application for SSO, you need the following:

  • An active NetExam account for your organization.

  • A signed certificate.

  • You can either download one from the Identity Administration portal or use your organization’s trusted certificate.

  • Contact information for NetExam support (to enable and test the SSO feature on your account).

Set up the certificates for SSO

To establish a trusted connection between the web application and CyberArk Identity, you need to have the same signing certificate in both the application and the application settings in the Identity Administration portal.

If you use your own certificate, you upload the signing certificate and its private key in a .pfx or .p12 file to the application settings in the Identity Administration portal. You also upload the public key certificate in a .cer or .pem file to the web application.

What you need to know about NetExam

Each SAML application is different. The following table lists features and functionality specific to NetExam.

Capability

Supported?

Support details

Web browser client

Yes

 

Mobile client

No

 

SAML 2.0

Yes

 

SP-initiated SSO

No

 

IdP-initiated SSO

Yes

 

Access restriction using a corporate IP range

Yes

You can specify an IP Range in the Identity Administration portal Policy page to restrict access to the application.

Configure NetExam in the Identity Administration portal (Part 1)

  1. In the Identity Administration portal, click Apps, then click Add Web Apps.

    The Add Web Apps screen appears.

  2. On the Search tab, enter the partial or full application name in the Search field and click the search icon.

  3. Next to the application, click Add.

  4. In the Add Web App screen, click Yes to confirm.

    Identity Administration portal adds the application.

  5. Click Close to exit the Application Catalog.

    The application that you just added opens to the Application Settings page.

    The description of how to choose and download a signing certificate in this document might differ slightly from your experience. See Choose a certificate file for the latest information.

  6. Click Download Signing Certificate and save the file to use in NetExam SAML Single Sign-On (SSO).

  7. (Optional) On the Application Settings page, click Enable Derived Credentials for this app on enrolled devices (opens in built-in browser) to use derived credentials on enrolled mobile devices to authenticate with this application.

    See CyberArk-issued derived credentials for more information.

  8. On the Application Settings page, expand the Additional Options section and specify the following settings:

    Option

    Description

    Application ID

    Configure this field if you are deploying a mobile application that uses the CyberArk mobile SDK. CyberArk Identity uses the Application ID to provide single sign-on to mobile applications. Note the following:

    The Application ID has to be the same as the text string that is specified as the target in the code of the mobile application written using the mobile SDK. If you change the name of the web application that corresponds to the mobile application, you need to enter the original application name in the Application ID field.

    There can only be one SAML application deployed with the name used by the mobile application.

    The Application ID is case-sensitive and can be any combination of letters, numbers, spaces, and special characters up to 256 characters.

    Show in User app list

    Select Show in User app list so that this web application displays in the user portal. (By default, this option is selected.)

    If this web application is only needed in order to provide SAML for a corresponding mobile application, deselect this option. This web application won’t display for users in the user portal.

  9. (Optional) On the Description page, you can change the name, description, and logo for the application. For some applications, the name cannot be modified.

    The Category field specifies the default grouping for the application in the user portal. Users have the option to create a tag that overrides the default grouping in the user portal.

  10. On the User Access page, select the role(s) that represent the users and groups that have access to the application.

    When assigning an application to a role, select either Automatic Install or Optional Install:

    • Select Automatic Install for applications that you want to appear automatically for users.

    • If you select Optional Install, the application doesn’t automatically appear in the user portal and users have the option to add the application.

  11. (Optional) On the Policy page, specify additional authentication controls for this application.

    1. Click Add Rule.

      The Authentication Rule window displays.

    2. Click Add Filter on the Authentication Rule window.

    3. Define the filter and condition using the drop-down boxes.
      For example, you can create a rule that requires a specific authentication method when users access CyberArk Identity from an IP address that is outside of your corporate IP range. Supported filters are:

      Filter

      Description

      IP Address

      The authentication factor is the computer’s IP address when the user logs in. This option requires that you have configured the IP address range in Settings, Network, Secure Zones.
       

      The authentication factor is the cookie that is embedded in the current browser by CyberArk Identity after the user has successfully logged in.

      Day of Week

      The authentication factor is the specific days of the week (Sunday through Saturday) when the user logs in.

      Date

      The authentication factor is a date before or after which the user logs in that triggers the specified authentication requirement.

      Date Range

      The authentication factor is a specific date range.

      Time Range

      The authentication factor is a specific time range in hours and minutes.

      Device OS

      The authentication factor is the device operating system.

      Browser

      The authentication factor is the browser used for opening CyberArk Identity user portal.

      Country

      The authentication factor is the country based on the IP address of the user computer.

      Risk Level

      The authentication factor is the risk level of the user logging on to user portal. For example, a user attempting to log in to CyberArk Identity from an unfamiliar location can be prompted to enter a password and text message (SMS) confirmation code because the external firewall condition correlates with a medium risk level. This Risk Level filter, requires additional licenses. If you do not see this filter, contact CyberArk Identity support. The supported risk levels are:

      Non Detected -- No unexpected activities are detected.

      Low -- Some aspects of the requested identity activity are unexpected. Remediation action or simple warning notification can be raised depending on the policy setup.

      Medium -- Many aspects of the requested identity activity are unexpected. Remediation action or simple warning notification can be raised depending on the policy setup.

      High -- Strong indicators that the requested identity activity is anomaly and the user's identity has been compromised. Immediate remediation action, such as MFA, should be enforced.

      Unknown -- Not enough user behavior activities (frequency of system use by the user and length of time user has been in the system) have been collected.

      Managed Devices

      The authentication factor is the designation of the device as “managed” or not. A device is considered “managed” if it is managed by CyberArk Identity, or if it has a trusted certificate authority (CA has been uploaded to tenant).

      For the Day/Date/Time related conditions, you can choose between the user’s local time and Universal Time Coordinated (UTC) time.

    4. Click the Add button associated with the filter and condition.

    5. Select the profile you want applied if all filters/conditions are met in the Authentication Profile drop-down.

      The authentication profile is where you define the authentication methods. If you have not created the necessary authentication profile, select the Add New Profile option. See Create authentication profiles.

    6. Click OK.

  12. (Optional) In the Default Profile (used if no conditions matched) drop-down, you can select a default profile to be applied if a user does not match any of the configured conditions.

    If you have no authentication rules configured and you select Not Allowed in the Default Profile dropdown, users will not be able to log in to the service.

  13. Click Save.

    If you have more than one authentication rule, you can prioritize them on the Policy page. You can also include JavaScript code to identify specific circumstances when you want to block an application or you want to require additional authentication methods. For details, see Application access policies with JavaScript.

    If you left the Apps section of the Identity Administration portal to specify additional authentication control, you will need to return to the Apps section before continuing by clicking Apps at the top of the page in the Identity Administration portal.

  14. On the Account Mapping page, configure how the login information is mapped to the application’s user accounts.

    The options are as follows:

    • Use the following Directory Service field to supply the user name: Use this option if the user accounts are based on user attributes. For example, specify an Active Directory field such as mail or userPrincipalName or a similar field from the CyberArk Cloud Directory.

    • Everybody shares a single user name: Use this option if you want to share access to an account but not share the user name and password. For example, some people share an application developer account.

    • Use Account Mapping Script: You can customize the user account mapping here by supplying a custom JavaScript script. For example, you could use the following line as a script:

      LoginUser.Username = LoginUser.Get('mail')+'.ad';

      The above script instructs CyberArk Identity to set the login user name to the user’s mail attribute value in Active Directory and add ‘.ad’ to the end. So, if the user’s mail attribute value is Adele.Darwin@acme.com then CyberArk Identity uses Adele.Darwin@acme.com.ad. For more information about writing a script to map user accounts, see the SAML application scripting.

  15. (Optional) On the Advanced page, you can edit the script that generates the SAML assertion, if needed. In most cases, you don’t need to edit this script. For more information, see the SAML application scripting.

  16. (Optional) On the Changelog page, you can see recent changes that have been made to the application settings, by date, user, and the type of change that was made.

  17. (Optional) Click Workflow to set up a request and approval work flow for this application.

    See Manage application access requests for more information.

  18. Click Save.

  1. Locate the Signing Certificate file you downloaded from the Application Settings page in the Identity Administration portal (NetExam SAML Single Sign-On (SSO) of Configure NetExam in the Identity Administration portal (Part 1)).

  2. Contact your NetExam support representative and provide them with the following:

    • Assertion Consumer Service (ACS) URL from the Application Settings page in the Identity Administration portal

    • The Signing Certificate file

  3. NetExam will send your company ID.

Configure NetExam in the Identity Administration portal (Part 2)

Before completing this section, you must have received a Company ID from NetExam. For more information, see NetExam SAML Single Sign-On (SSO).

  1. Return to the browser tab you were using to work in the Identity Administration portal in Configure NetExam in the Identity Administration portal (Part 1) and navigate to the Application Settings screen of your NetExam app.

  2. Configure the following:

    Field

    Required or optional

    Set it to

    What you do

    Your Company ID

    Required

    The ID provided by NetExam.

    Enter the company ID provided by NetExam.

  3. Click Save.

  4. (Optional) To configure the NetExam application for automatic provisioning, see NetExam SAML Single Sign-On (SSO).

For more information about NetExam

For more information about configuring NetExam for SSO, contact NetExam support.