Skip to main content

Who is this article for?

Incydr Professional and Enterprise
Incydr Basic and Advanced
Other product plans

Incydr Professional and Enterprise, yes.

Incydr Basic and Advanced, yes.

CrashPlan Cloud, yes.

Other product plans, yes.

CrashPlan for Small Business, no.

This article applies to Code42 cloud environments.

Other available versions:

On-premises

HOME
GETTING STARTED
RELEASE NOTES
FAQs
APIs
SYSTEM STATUS
Code42 Support

Configure OneLogin for SSO in your Code42 cloud environment

Who is this article for?

Incydr Professional and Enterprise
Incydr Basic and Advanced
Other product plans

Incydr Professional and Enterprise, yes.

Incydr Basic and Advanced, yes.

CrashPlan Cloud, yes.

Other product plans, yes.

CrashPlan for Small Business, no.

This article applies to Code42 cloud environments.

Other available versions:

On-premises

Overview

This tutorial explains how to configure your Code42 environment with on on-premises authority server to use single sign-on (SSO) with OneLogin. In this article, OneLogin is also referred to as an identity provider.

This article assumes you are already familiar with SSO and the SAML standard. For more information about how the Code42 platform implements SSO, see our Introduction to single sign-on.

Compatible Code42 platform components

Compatible With SSO
  • Code42 app for Windows, Mac, and Linux
  • Code42 console
Incompatible With SSO
  • Code42 apps for iOS, Android, and Windows Phone

Considerations

  • Code42 usernames must match SSO usernames. How you accomplish this depends on how you deploy Code42 apps.
  • Code42 supports service provider-initiated SSO but does not support identity provider-initiated SSO. Therefore, users cannot sign in to your Code42 environment from the identity provider's website or application, but instead must log in using a browser bookmark. 
  • SSO provides user authentication but does not provide user management. Set up SCIM provisioning or use the Code42 console to manage users
  • Code42 does not support Single Logout (SLO). Users must sign out of the identity provider to end their single sign-on session.
  • To configure Code42 to support advanced SAML request configurations using the Code42 API, see Use the Code42 API to set SAML attributes
External authentication systems
Our Customer Champions can help with authentication issues caused by interaction with Code42 products. However, troubleshooting authentication issues outside your Code42 environment is beyond the scope of our Customer Champions. For assistance with external authentication systems, contact your authentication vendor.

Before you begin

Verify identity provider configuration
  • Make sure the SSL certificate of your SSO identity provider has been signed by a trusted Certificate Authority (CA).
  • Make sure you have administrative access to the identity provider or have contact with an identity provider administrator.
Verify network configuration
  • Configure your private network, Internet, and VPN settings to allow client devices to communicate with your identity provider on port 443. Test client connectivity to the identity provider before you proceed.
  • If you want to use URL-based metadata exchange to configure Code42 and the identity provider to work together, make sure two-way communication is available between them on TCP port 443. If two-way communication is not available or not allowed, you must download the identity provider's metadata file and make it accessible to Code42.
  • Confirm the required ports with your identity provider to determine if custom ports are being used.

Determine whether you need to configure multiple Code42 tenants

Before you begin configuring SSO for Code42, consider whether your company has more than one Code42 tenant that you need to connect to your SSO identity provider. Large companies and organizations often have separate, dedicated Code42 cloud instances (or "tenants") in use by different groups or departments. 

If you have more than one Code42 tenant to connect to your SSO identity provider, you need to obtain an entity ID URL for each Code42 tenant. An entity ID is a unique string that identifies a specific tenant to your SSO identity provider. The tenant-specific entity ID URL is composed of the Code42 domain followed by the tenant ID, and can be found in the Code42 service provider metadata URL file in each tenant. For example:

"entityId": "https://example.com/42424daa-424c-4e42-42c4-c424242420d4" 

Step 1: Determine the URLs for your Code42 environment

When you configure an identity provider to connect to Code42, typically you must provide the Code42 server login URL, entity ID, and Assertion Consumer Service (ACS) URL. To obtain these values: 

  1. Sign in to the Code42 console.
  2. Navigate to Administration > Integrations > Identity Management.
  3. Locate the Code42 service provider metadata URL:
    • When setting up an authentication provider for the first time, the URL appears on the main screen:
      Code42 service provider metadata URL on main screen
    • If you previously set up an authentication provider, the URL appears in the authentication provider details:
      Code42 service provider metadata URL on details screen.png
       
  4. The first portion of the URL is your Code42 server URL, for example, https://example.com. Record this URL for use later.
    To determine the login URL, add /login to the end. For example, https://example.com/login.
  5. Copy the Code42 service provider metadata URL and paste it in the address bar of a new browser window. 
    Your Code42 environment's metadata details appear. 
  6. Find the entityID. Record this URL for use later.
    obtain_entity_id_with_tenant_id_final.png
  7. Find the AssertionConsumerService and its Location URL value, for example, Location="https://example.com/api/SsoAuthLoginResponse". Record this URL for use later.
    ACS URL

Step 2: Prepare OneLogin

  1. Sign in to the OneLogin dashboard.
  2. Select Add Apps and search for Code42 CrashPlan.
  3. Add Code42 CrashPlan, and click Save.
  4. In the OneLogin Configuration tab, complete the fields with values you obtained in Step 1. For example:
    • SAML Consumer URL: https://example.com/api/SsoAuthLoginResponse 
    • Login URL: https://example.com/api/SspAuthSPMetadata?registrationKey=42424242424242424242 
      Note that instead of the expected login URL, enter the Code42 Service Provider Metadata URL you obtained in Step 1.
  5. Click Save.
  6. In the SSO tab, copy the value from the Issuer URL field, for example: https://app.onelogin.com/saml/metadata/123456
    This value is the Provider's Metadata URL you will paste in to the Code42 console in the next step. 

Step 3: Add OneLogin as an authentication provider in Code42

  1. Sign in to the Code42 console.
  2. Navigate to Administration > Integrations > Identity Management.
  3. Click Add authentication provider.
    The Add Authentication Provider dialog appears.
    Add Authentication Provider dialog
  4. In Display Name, enter an identity provider name to display to users who sign in with SSO.
    If your Code42 environment provides more than one SSO identity provider, users see a list of providers to choose from. They must select the provider configured for their Code42 organization.
  5. In Provider's Metadata, ensure that Enter URL is selected and paste the URL for the identity provider metadata XML file, or click Upload XML File and select the XML file for upload.
    Custom domains are not supported
    When entering the URL for the XML metadata file, custom domains are not supported. You must use the standard domain of your identity provider. 
  6. Click Create Provider.
    Authentication provider settings appear.
    Authentication provider details
Provider information message

Note the following message on the dialog:
This provider will not be applied to an organization until you update the organization security settings.

Do not apply this authentication provider to organizations yet. You will apply this provider to a test organization and to production organizations in later steps.
  1. (Optional) Code42 recommends using the default settings, but you can use Attribute Mapping to customize mappings between Code42 platform user attributes and authentication provider SSO assertion attributes.
    1. Click Edit.Edit_icon.png
    2. Deselect Use default mapping.
    3. Configure mapping settings for each Code42 platform user attribute.
      Each field supports up to 128 characters. 
      • Username: Specify the SSO identifier or attribute that maps to the Code42 platform username.
        • Select Use nameId to use the SSO name identifier.
        • Select Use attribute tag to enter a custom SSO attribute.
      • Email: Enter the SSO attribute that contains user email addresses.
      • First Name: Enter the SSO attribute that contains user first names.
      • Last Name: Enter the SSO attribute that contains user last names.
    4. Click Save.
  2. (Optional) Local Users displays the current user. If there are any other users you want to exempt from using this authentication provider to log in, enter them here. 

Step 4: Test SSO authentication

  1. Create a test user in your identity provider. 
  2. Sign in to the Code42 console.
  3. Create a test organization.
  4. Configure the test organization to use SSO.
    1. Navigate to Administration > Integrations > Organizations, then select the organization.
    2. From the action menu in the upper-right, select Edit.
    3. Click Security.
      Security tab
    4. Edit these settings in the Server section of the panel:
      1. Deselect Inherit security settings from parent.
      2. From Select an authentication method, choose SSO.
        The configured SSO identity providers appear.
      3. Select the identity providers that you want to offer for the organization.
      4. From Select a directory service, select Local.
    5. Click Save.
      The Enable Single Sign-on dialog appears.
      Enable SSO dialog
    6. Type ENABLE in the field provided and click Enable.
      The settings are saved to the organization. 
    7. To verify the settings, re-open the Security tab. Under Choose providers you should see the check box selected for your identity provider.
  5. Create a user in the test organization who matches the identity provider test user.
  6. In the upper-right of the Code42 console, select Account Account icon  > Sign Out.
  7. Sign back in to the Code42 console as the test user to verify that SSO is working.

Step 5: Configure organizations to use SSO

Enable SSO for one or more organizations in your Code42 environment. If two or more authentication providers are offered in your Code42 environment, tell the users in each organization which authentication provider they should choose when they sign in.

Option A: Enable SSO for a specific organization

  1. Sign in to the Code42 console.
  2. Navigate to Administration > Environment > Organizations, then select the organization.
  3. From the action menu, select Edit.
  4. Click Security.
    Security tab
  5. Deselect Inherit security settings from parent.
    Disabled inheritance
    If you disable inheritance for an organization, that organization is not affected by changes to its parent organization.
  6. From Select an authentication method, choose SSO.
    The configured authentication providers appear.
  7. Select the identity providers that you want to offer for the organization.
  8. From Select a directory service, select Local.
  9. Click Save.

Option B: Enable SSO for all organizations

Modify the system-wide organization settings to enable SSO for all organizations.

  1. Sign in to the Code42 console.
  2. Go to Administration > Environment > Organizations.
  3. Click on the top-level organization.
    The organization details appear.
  4. From the action menu, select Edit.
  5. Click Security.
    Apply provider to parent organization
  6. From Select an authentication method, choose SSO.
    The configured authentication providers appear.
  7. Select the identity providers that you want to offer to your organizations.
  8. From Select a directory service, select Local.
  9. Click Save.
  10. Under each child organization, make sure that Inherit security settings from parent is enabled.
    1. Click the child organization.
    2. From the action menu, select Edit.
    3. Click Security.
    4. Enable Inherit security settings from parent.

Step 6: Add new users that sign in with SSO

Option A: Add users in the Code42 console

Use the Code42 console to add users to an organization that uses SSO.

  • Verify that the users in the organization exist in the SSO identity provider used by the organization.
  • Make sure that the Code42 environment usernames match the SSO usernames.

Option B: Deploy the Code42 app

New users can register accounts in your Code42 environment:

  1. Distribute the Code42 app installer to new users
  2. Choose Sign up for an account when you open the Code42 app.
  3. Create an account using the SSO credentials. The Code42 app username must match the SSO username.

What to expect

Reduced authentication prompts

When users sign in with SSO, they do not need to re-enter credentials for subsequent authentication attempts until the SAML authentication token expires. A SAML token applies to an application rather than a device, which means that a user might need to enter credentials again when signing into a different app. 

For example, the single sign-in process differs whether users sign in to the Code42 console or the Code42 app:

  • Code42 console: When users sign in to the Code42 console, they are redirected in the web browser to sign in to their SSO identity provider. As soon as they sign in to their identity provider, the Code42 console launches. 
  • Code42 app: When users sign in to the Code42 app, following message appears: "To complete the sign in process, go to your web browser. This screen updates automatically once login is successful." A web browser window is automatically opened so they can complete the sign-in process in their SSO identity provider.  As soon as they sign in to their SSO identity provider in the provided web browser window, the Code42 app launches.

Losing access to an identity provider

If a user loses access to the identity provider, the Code42 app continues to back up, uninterrupted.

External resources

  • Was this article helpful?