Skip to main content

This article applies to Cloud.

Other available versions:

Version 6 | Version 5 | Version 4icon.qnmark.png

Available in:

StandardPremiumEnterprise
Small Business
Code42 Support

Configure Microsoft AD FS for SSO in your Code42 cloud environment

This article applies to Cloud.

Other available versions:

Version 6 | Version 5 | Version 4icon.qnmark.png

Available in:

StandardPremiumEnterprise
Small Business

Overview

This tutorial explains how to configure your Code42 cloud environment to use single sign-on (SSO) with Microsoft Active Directory Federation Services (AD FS) 3.0. This article applies to environments in the Code42 cloud only. If you have an on-premises authority server, see Configure Microsoft AD FS for SSO in your Code42 environment.

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

Compatible Code42 platform components

Compatible with SSO
  • Code42 app for Windows, Mac, and Linux
  • Administration 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.
  • Users cannot sign in to your Code42 environment from an identity provider's website or application. The administration console supports service provider-initiated SSO but does not support identity provider-initiated SSO.
  • SSO provides user authentication but does not provide user management. Set up SCIM provisioning or use the Code42 administration console to manage users. 
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 ports 80 and 443. Test client connectivity to the identity provider before you proceed.
  • If you want to use URL-based metadata exchange to configure your Code42 cloud instance and identity provider to work together, make sure two-way communication is available between them on TCP ports 80 and 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 your administration console.
  • Confirm the required ports with your identity provider to determine if custom ports are being used.

Step 1: Add AD FS as an authentication provider

To complete this step, you must first verify that AD FS is deployed according to Microsoft's instructions.

  1. Sign in to the Code42 administration console.

  2. Navigate to Settings > Identity Management.
    Identity Management in the console
  3. Click Add Authentication Provider.
    Add Authentication Provider dialog
  4. In Display name, enter an identity provider name to display to users that 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, choose one of the following options:  
    •  Enter URL: Paste the URL for the AD FS metadata XML file, for example:https://<adfs-server>/federationmetadata/2007-06/federationmetadata.xml
    • Upload XML  File: Upload the AD FS metadata XML file to your instance of the administration console.
  6. Click Create Provider.
    Authentication provider settings appear.
  7. Copy the Code42 Service Provider Metadata URL. You will use this in the Step 2 to create a relying party trust between AD FS and your Code42 administration console.
    Identity Management 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 the Edit icon. Edit_icon.png
    2. Deselect Use default mapping.
    3. Configure mapping settings for each Code42 platform user attribute:
      • 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 2: Add the Code42 service provider metadata URL to AD FS

  1. If there is a mix of Windows, Mac, and Linux computers in your Code42 environment, go to Edit Global Authentication Policy in AD FS, and enable both Windows authentication and Forms authentication. See Microsoft's instructions
  2. Create a relying party trust between AD FS and your Code42 administration console.
    1. Follow the wizard steps to configure the relying party trust.
    2. When you are prompted for the relying party metadata, provide the URL you copied from the Code42 Service Provider Metadata URL in the Step 1
  3. Configure the relying party trust for Code42 to use the SHA-1 hash algorithm.
    1. Right-click the relying party trust, then select Properties.
    2. Click Advanced.
    3. From Secure hash algorithm, select SHA-1.

Step 3: Test SSO authentication

To start, create a test user in AD FS. Then create a test organization in the administration console.

  1. Create a test user in your identity provider. 
  2. Sign in to the administration console.
  3. Create a test organization.
  4. Configure the test organization to use SSO.
    1. Navigate to Organizations, then select the organization.
    2. From the action menu in the upper-right, select Edit.
    3. Click Security.
      Security tab
    4. Deselect Inherit security settings from parent.
    5. From Select an authentication method, choose SSO.
      The configured SSO identity providers appear.
    6. Select the identity providers that you want to offer for the organization.
    7. From Select a directory service, select Local.
    8. Click Save.
  5. Create a user in the test organization who matches the identity provider test user.
  6. In the upper-right of the administration console, select Account > Sign Out.
  7. Sign back in to the administration console as the test user to verify that SSO is working.

Step 4: Apply this provider to production organizations

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 administration console.
  2. Navigate to 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 administration console.
  2. Go to Organizations > Active.
    Parent organization hierarchy
  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 5: Add new users who sign in with SSO

  1. In AD FS, add new users for whom you want to enable login to Code42. See Microsoft's documentation for information about adding users.
  2. Ensure the same users are set up in Code42. You can add users manually with the administration console to an organization that uses SSO, enable SCIM provisioning, or deploy Code42 apps to users in an organization that uses SSO.

What to expect

Reduced authentication prompts

When a user signs in with SSO, the user does 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. Signing in to the Code42 app does not authenticate the administration console because one is an app on the device and the other is accessed via a web browser.

Lost access to an identity provider

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