Configure Single-Sign-On (SSO) with OneLogin

This article describes how to configure Single-Sign On (SSO) between NetVendor Maintenance and OneLogin

This article is intended for systems administrators at our client companies. In order to follow these instructions, you will require access to your OneLogin Administration Portal.

In order to configure SSO between NetVendor Maintenance (NVM) and OneLogin, some configuration will need to be completed in the OneLogin Administration Portal by your team, and then some configuration will need to be completed by the NVM Support Team.

At a high-level, these are the steps you will need to complete:

1. Create a Custom SAML Application in OneLogin
2. Configure your new SAML Application for NetVendor
3. Share your app's Metadata XML with NetVendor
4. Provide your users access to the new application

These steps are described in detail below.

Create a Custom SAML App in OneLogin

From the OneLogin admin portal:

1. Visit the applications tab and choose "Add App"
2. Search for "SAML Custom Connector"
3. Choose the "SAML Custom Connector (Advanced)" app template
4. Fill in "Display Name" with "NetVendor Maintenance"
5. Upload the rectangular and square logos provided below
6. Provide any description you feel may be useful for your users
7. Click "Save"

NetVendor Maintenance Rectangular Logo

Download PNG

NetVendor Maintenance Square Icon

Download PNG

Configure Your New SAML Application for NetVendor

Configuration Tab

On the "Configuration" tab of your new "NetVendor Maintenance" app, enter the following values:

All other fields can be left on their defaults.

Parameters Tab

On the "Parameters" tab of your new "NetVendor Maintenance" app, you will define which user fields NetVendor Maintenance will receive.

1. Leave untouched the default setting for "Credentials are" - it should be set to "Configured by admin"
2. Leave untouched the default setting for "NameID value" - it should be set to "Email"
3. Add additional parameters according to the procedure and table below:
   1. Click the "+" icon to create a new field
   2. For "Field name", copy-and-paste a field name from a row in the table below
   3. Under "Flags", check "Include in SAML assertion"
   4. Click "Save", which will then reveal a dropdown select for "Value"
   5. Choose the corresponding value from the same row in the table below
   6. Click "Save" again
   7. Continue this process for every row in the table below

Other Application Tabs

No other changes are required. However, you may change the Access policy according to your internal security and access needs.

Note: you will configure User Access in an upcoming step.

Share Your App's Metadata XML with NetVendor

Now that your app is configured, NetVendor needs to know about the app and how to communicate with it. For this to happen you will need to send the app's Metadata XML to us:

1. From any of the application configuration tabs, click the "More Actions" button in the top right (near the Save button)
2. Click on "SAML Metadata"
3. A file will be downloaded to your computer, e.g. `onelogin_metadata_1234567.xml`
4. Email this file to `maintenance@netvendor.com`, along with a domain (or list of domains) that will be used in the email addresses of your users signing in. (When a user types an email address into our login field with a matching domain, we will show them the "Login with OneLogin" button!)

Once we receive the file, we will install it and let you know that SSO is ready for testing!

Provide your users access to the new application

In order to login to NetVendor Maintenance via SSO, you will need to assign users or roles within OneLogin to the Application you just created. Who you assign depends on who you want to have login access to NetVendor Maintenance - anyone you do not assign will not be able to log in!

How you assign access in OneLogin is outside the scope of this article. However, the OneLogin support article about roles provides a comprehensive overview of the procedure.

Your Users May Now Login

Logging in from NetVendor Maintenance

1. Visit https://app.servusconnect.com
2. Enter your corporate email in the Email field
3. As long as the email domain matches one that was provided to us along with your Metadata XML file, the user will be presented with a "Login with OneLogin" button
4. Click the "Login with OneLogin" button to be directed to sign-in
5. If there is an existing NetVendor Maintenance user matching the SSO authentication, they will be immediately logged in. Otherwise, they will enter the Waiting Room. Please work with our team to have matching users provisioned in NetVendor Maintenance.