Overview

The Single Sign-On (SSO) Management page makes it easy to add SSO configurations. From Single Sign-On (SSO) Management, you can easily add, preview, and manage SSO configurations in your environment using the SSO dashboard.

Unqork as a SAML service provider secures applications that work with sensitive information. Having {{glossary.end-users}} use SSO (single sign-on) to access your application improves security for all. When setting up SSO, you can select the authentication provider for your Unqork application, instead of having Unqork store end-user credentials. Using SSO also gives your end-user fewer credential sets to remember. Your end-user gets a seamless login experience, and you can trust your SSO provider to ensure the right people have access to your application.

You can set up SSO configurations for the following:

Express View Access: For authentication to the front-end of an application.
Designer Access: For authentication for your Unqork environment {{glossary.Creators}}.

SSO configuration must be manually configured at each Unqork environment level: Staging, QA, UAT, and Production. SSO configurations in Single Sign-On (SSO) Management cannot be promoted to other environment levels. Each environment level should have a separate SSO configuration to ensure incorrect permissions are not accidentally granted in higher environment levels.

When adding your SSO configuration, choose one of two protocols supported by Unqork: {{glossary.SAML}} (Security Assertion Markup Language) or {{glossary.OIDC}} (OpenID Connect).

SSO Management also supports hard-coding application roles. To specify application roles, use the following format: <applicationId>:<roleName>. To specify multiple application roles, use a comma-separated list.

In this article, you'll learn the basics of using the Single Sign-On (SSO) Management page. In the Related Resources section, you can find links to related articles, including provider-specific how-to guides and detailed articles about SAML and OIDC in Unqork.

The SSO Dashboard

The SSO dashboard is where you add, review, and manage SSO configurations in your environment. You can have SSO configurations from different Identity Providers (IDPs) or OpenID Providers (OPs) configured in your environment. Each SSO configuration has a unique callback URL ({{glossary.SAML}}) or redirect URL ({{glossary.OIDC}}) that contains the SSO configuration's unique name.

Here’s an example of the dashboard with several SSO configurations:

The SSO dashboard includes the following tabs:

Express: From the Express tab, you can add and review your SSO configurations for {{glossary.Express View}}.
Designer: From the Designer tab, you can add and review your SSO configurations for Designer access.

Each tab has a similar dashboard, where you can gather some useful information:

Column	Column Description
Name	The SSO configuration's name. SSO configuration names are customizable labels you set when adding the SSO configuration.
Protocol	Which protocol the SSO configuration uses: {{glossary.SAML}} or {{glossary.OIDC}}.
Default Role	The default role for users who authenticate using the SSO configuration. For Express SSO configurations, the default role is an Express role, defined in Express Role Administration. For Designer SSO configurations, the default role is a {{glossary.Creator}} role, defined in Creator (User) Administration.
Actions	From the Manage drop-down, you can view, edit, preview, or delete an SSO configuration.

Add Express View SSO

Add Designer SSO

Preview SSO

View SSO

Edit SSO

Delete SSO

Adding an SSO Configuration for Express View

These instructions outline the basic steps to add an SSO configuration to the SSO dashboard. The individual steps and field values vary based on your SSO provider, and whether you configure SAML or OIDC. See the Related Resources section for further information.

At the top right of the Unqork Designer Platform, Click Administration.
Under Environment, select Single Sign-On (SSO).
Click + New SSO.
Select Express. The New Express SSO configuration {{glossary.modal - LC}} opens.
In the SSO Name field, enter a name for your SSO configuration.
SSO configuration names must be unique.
Select a Default Role. The drop-down contains a list of all Express Roles defined in Express Role Administration.
Leaving this empty defaults to a role with the lowest-level permissions.
Select a Default Group. The drop-down contains a list of all Express Groups defined in Express Group Administration.
It's a best practice to select a default group with the lowest-level permissions. Leaving this empty defaults the end-user to no group.
Click Next to move to the Configure Protocol tab.
Select the Protocol.
Complete the IdP Details, Configuration Details, and Advanced Settings as required.
It's possible to have multiple IDP configurations for a single application.
See the Related Resources section for detailed articles covering what to enter in each field, including provider-specific how-to guides.
Click Next to move to the Attribute Mapping tab.
Complete the Attribute Mapping and User Management settings as required.
See the Unqork as a SAML Service Provider or OpenID Connect (OIDC) articles for detailed information about adding attribute mappings to a SAML or OIDC-based SSO configuration.
Click Create SSO.

Adding an SSO Configuration for Designer

These instructions outline the basic steps to add an SSO configuration to the SSO dashboard. The individual steps and field values vary based on your SSO provider, and whether you use SAML or OIDC. See theRelated Resources section for further information.

At the top right of the Unqork Designer Platform, click Administration.
Under Environment, select Single Sign-On (SSO).
Click + New SSO.
Select Designer. The New Designer SSO configuration {{glossary.modal - LC}} opens.
Enter a name for your SSO configuration in the SSO Name field.
SSO configuration names must be unique.
Select a Default Role. The drop-down contains a list of all Creator roles defined in Creator (User) Role Administration.
Leaving this empty defaults to a role with the lowest-level permissions.
Click Next to move to the Configure Protocol tab.
Select the Protocol.
Complete the IdP Details, Configuration Details, and Advanced Settings as required.
See the Related Resources section for detailed articles covering what to enter in each field, including provider-specific how-to guides.
Click Next to move to the Attribute Mapping tab.
Complete the Attribute Mapping and User Management settings as required.
See the Unqork as a SAML Service Provider or OpenID Connect (OIDC) articles for detailed information about adding attribute mappings to a SAML or OIDC-based SSO configuration.
Click Create SSO.

Previewing an SSO Configuration

After adding an SSO configuration, preview it to confirm it works. From the SSO dashboard, you can preview the Unqork entrypoint and use a set of test credentials from your SSO provider to test the configuration.

For SAML-based configurations, previewing your configuration only tests an SP-initiated flow. Remember to also test an IdP-initiated flow. Our provider-specific how-to guides have more information.

To preview an SSO configuration:

At the top right of the Unqork Designer Platform, click Administration.
Under Environment, select Single Sign-On (SSO).
Select the Express or Designer tab.
In the SSO dashboard, locate the SSO configuration to preview.
Under the Actions column, click Manage.
From the Manage drop-down, select Preview. The Unqork entrypoint link opens in a new tab.
You might need to preview your configuration in an Incognito window to properly test the configuration. In that case, right-click Preview and select Copy Link Address. Then, paste the link address in a new Incognito window.
Log in using your test credentials.

Viewing an SSO Configuration

After adding an SSO configuration, it's useful to review its configuration details, like attribute mappings.

To view an SSO configuration:

At the top right of the Unqork Designer Platform, click Administration.
Under Environment, select Single Sign-On (SSO).
Select the Express or Designer tab.
In the SSO dashboard, locate the SSO configuration to view.
Under the Actions column, click Manage.
From the Manage drop-down, select Edit. The SSO configuration {{glossary.modal - LC}} opens.
Review the settings in the Basic Information, Configure Protocol, and Attribute Mapping tabs as needed.
Click Done.

Editing an SSO Configuration

At some point you might need to edit the SSO configuration's details. For example, revising attribute mappings or default groups. You'll view and edit SSO configurations from the same SSO configuration modal. To edit your SSO configuration, you must intentionally enable editing.

To edit an SSO configuration:

At the top right of the Unqork Designer Platform, click Administration.
Under Environment, select Single Sign-On (SSO).
Select the Express or Designer tab.
In the SSO dashboard, locate the SSO configuration to edit.
Under the Actions column, click Manage.
From the Manage drop-down, select Edit. The SSO configuration {{glossary.modal - LC}} opens.
Set Edit to (ON).
Make changes to the settings in the Basic Information, Configure Protocol, and Attribute Mapping tabs as needed.
Click Save.

Deleting an SSO Configuration

Whether an SSO configuration is no longer needed or you changed SSO providers, you'll need to delete SSO configurations from your SSO dashboard at some point.

Deleting an SSO configuration is permanent and irreversible.

To delete an SSO configuration:

At the top right of the Unqork Designer Platform, click Administration.
Under Environment, select Single Sign-On (SSO).
Select the Express or Designer tab.
In the SSO dashboard, locate the SSO configuration to delete.
Under the Actions column, click Manage.
From the Manage drop-down, select Delete.
At the confirmation message, click Yes, Delete.

Related Resources

The following articles provide additional information related to SSO configuration:

General Information

Unqork as a SAML Service Provider: Detailed information about SAML and SAML-based configurations, including what to enter in each field.
OpenID Connect (OIDC): Detailed information about OIDC and OIDC-based configurations, including what to enter in each field.

Provider-Specific How-to Guides: Express View (OIDC)

Provider-Specific How-to Guides: Express View (SAML)

Provider-Specific How-to Guides: Designer (SAML)