Subscribe to Help Center RSS FeedUse JumpCloud SAML Single Sign On (SSO) to give your users convenient but secure access to all their web applications with a single set of credentials. Automatically provision, update and deprovision users and groups in Egnyte from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for Egnyte. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.
Read this article to learn how to setup the Egnyte integration.
Prerequisites
- A JumpCloud administrator account.
- JumpCloud SSO Package or higher or SSO add-on feature.
- An Egnyte user account with administrator permissions with an Enterprise subscription.
- You need to generate an API Key.
- SSO must be configured for Egnyte prior to creating an Identity Management integration.
- Due to an update on the SAML SSO connector to correctly support SCIM on Egnyte, if you have a pre-existing SSO integration, you will need to recreate the Egnyte SAML app in order to support SCIM provisioning.
- When taking over an already existing user the IdP, Username will not be set and needs to be updated manually so it matches the username from JumpCloud.
- If you have to replace the SCIM Token, you must deactivate the IdM integration, change the token and then reactivate the integration.
- The userType attribute is required. When provisioning a new user, the userType will be set to power by default.
- Groups are supported.
Attribute Considerations
- A default set of attributes are managed for users. See the Attribute Mappings section for more details.
Creating a new JumpCloud Application Integration
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Click + Add New Application.
- Type the name of the application in the Search field and select it.
- Click Next.
- In the Display Label, type your name for the application. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.
If this is a Bookmark Application, enter your sign-in URL in the Bookmark URL field.
- Optionally, expand Advanced Settings to specify a value for the SSO IdP URL. If no value is entered, it will default to https://sso.jumpcloud.com/saml2/<applicationname>.
The SSO IdP URL is not editable after the application is created. You will have to delete and recreate the connector if you need to edit this field at a later time.
- Click Save Application.
- If successful, click:
- Configure Application and go to the next section
- Close to configure your new application at a later time
Configuring the SSO Integration
To configure JumpCloud
- Create a new application or select it from the the Configured Applications list.
- Select the SSO tab.
- Replace any instances of SUBDOMAIN with your Egnyte value.
- Add or change any attributes.
- Click save.
Download the certificate
- Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
- Select the SSO tab and click IDP Certificate Valid > Download certificate.
The certificate.pem will download to your local Downloads folder.
To configure Egnyte
- Log in to Egnyte as an Administrator.
- Click the menu icon in the upper right corner of the page, then select Settings.
- Navigate to Security & Authentication:
- Scroll down to the Single Sign-On Authentication section and enter the following values:
- Single sign-on authentication - select SAML 2.0 from the dropdown menu.
- Identity provider - select Generic HTTP Post from the dropdown menu.
- Identity provider login URL - copy and paste the JumpCloud IDP URL.
- Identity provider entity ID - copy and paste the JumpCloud IdP Entity ID.
- Identity provider certificate - copy the contents of the certificate downloaded in the previous section.
- API key - leave API Key blank.
- Default user mapping - Select Egnyte Username from the dropdown menu.
- Toggle the Use domain-specific Issuer value to the enabled state.
- Click Save.
If you have existing users in Egnyte that are not SSO-enabled - find the user(s) in the Users & Groups tab. Hover over the user(s) and click Details > Edit user profile. Ensure that all the details match the user in JumpCloud, change the Authentication type to Single Sign-on, set IdP username to match the username from JumpCloud, and click Save.
Authorizing User SSO Access
Users are implicitly denied access to applications. After you connect an application to JumpCloud, you need to authorize user access to that application. You can authorize user access from the Application Configuration panel or from the Groups Configuration panel.
To authorize user access from the Application Configuration panel
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
- Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
- Select the check box next to the group of users you want to give access.
- Click save.
To learn how to authorize user access from the Groups Configuration panel, see Authorize Users to an SSO Application.
Validating SSO user authentication workflow(s)
IdP-initiated user workflow
- Access the JumpCloud User Console
- Go to Applications and click an application tile to launch it
- JumpCloud asserts the user's identity to the SP and is authenticated without the user having to log in to the application
SP-initiated user workflow
- Go to the SP application login - generally, there is either a special link or an adaptive username field that detects the user is authenticated through SSO
This varies by SP.
- Login redirects the user to JumpCloud where the user enters their JumpCloud credentials
- After the user is logged in successfully, they are redirected back to the SP and automatically logged in
Configuring the Identity Management Integration
To generate your Egnyte API Key
This portal generates a valid OAuth token for any Egnyte Identity Provider.
- To generate the API Key, visit Egnyte SCIM 2.0 Setup.
- You will need to log in with your domain administrator credentials.
- Enter your Domain Name and click Get API Key.
The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the JumpCloud Password Manager, for future reference.
To configure JumpCloud
- Log in to the JumpCloud Admin Portal.
- Navigate to USER AUTHENTICATION > SSO.
- Search for Egnyte, then click on it to bring the information panel open.
- Select the Identity Management tab.,
- Click Configure.
- You’re presented with two fields:
- Base URL - enter https://{SUBDOMAIN}.egnyte.com/pubapi/scim/v2 where {SUBDOMAIN} is your Egnyte subdomain.
- Token Key - paste the API Key generated in the previous section.
- Deselect Enable management of User Groups and Group Membership in this application if you don't want to provision, manage, and sync groups.
- Click Activate.
Attribute Mappings
The following table lists attributes that JumpCloud sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations.
Learn about JumpCloud Properties and how they work with system users in our API.
Egnyte User Attributes
| JumpCloud Property | JumpCloud UI | SCIM v2 Mapping | Egnyte Value |
|---|---|---|---|
| Company Email | emails: value | ||
| username | Username | userName | IdP Username |
| firstname/lastname | First Name/Last Name | name.formatted | Display Name |
| firstname | First Name | name.givenName | First name |
| lastname | Last Name | name.familyName | Last name |
| - | - | userType | User Type |
Group Attributes
| JumpCloud Property | JumpCloud UI Field Name | SCIM v2 Mapping | Application Value |
|---|---|---|---|
| name | Name | displayName | Name |
Group Management Considerations
Enabling Group Management
You must select the Enable management of User Groups and Group Membership in this application option to manage groups and group membership in the application from JumpCloud.
Group Provisioning and Syncing
- Empty groups are not created
- JumpCloud takes over management of existing groups in the application when the user group name in JumpCloud matches the name of the group in the application
- All user groups associated with the application in JumpCloud are synced. Syncing occurs whenever there is a membership or group change event
- Group renaming is supported
- If a user group is disassociated from the application in JumpCloud, syncing immediately stops and the group is left as-is in the application. All members of that user group are deactivated in the application unless they are associated with another active application group that is managed from JumpCloud
Group Deletion
- Managed groups deleted in JumpCloud are deleted in the application
- All members of the deleted group are deactivated in the application, unless they are associated with another active application group that is managed from JumpCloud
Disabling Group Management
- You can disable group and group membership management by unchecking the Enable management of User Groups and Group Membership in this application option
- The managed groups and group membership are left as-is in the application
- JumpCloud stops sending group membership information for the user, but the user’s identity will continue to be managed from JumpCloud
Importing Users
This functionality is helpful if users have already been created in the application but have not been created in JumpCloud.
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application and click to open its configuration panel.
- Select the Identity Management tab.
- Click manual import.
- Select the users you want to create in JumpCloud from the application from the list of users that appear. Users in the list have two import statuses:
- New - user has not been imported
- Imported - user has been imported and has an account in JumpCloud
Tip: Try using the New Users-only filter when selecting users to import. This will move all of your new users to the top of the list, making them easier to identify and select.
- Click import.
- If you are importing less than 100 users, your import results will display in real time and you can continue onboarding your users
- If you have more than 100 users being imported, JumpCloud will send you an email when your import is complete
- You can now connect and grant users access to all their JumpCloud resources. Learn more in the Authorize Users to an Application and Connecting Users to Resources articles.
Warning: Imported users must be members of a user group bound to an application for JumpCloud to manage their identity in, and access to, the application.
SCIM Directory Insights Events
The following Directory Insights (DI) events provide visibility into failures and detailed information about the user and group data being added or updated from HR or other external solutions to JumpCloud.
Customers with no package or the Device Management Package will need to add the Directory Insights à la carte option. Directory Insights is included in all other packages.
SCIM DI Integration Events
| Event Name | Event Description |
|---|---|
| idm_integration_activate | Logged when an IT admin attempts to activated new SCIM Identity Management integration. |
| idm_integration_update | Logged when an IT admin attempts to update a configured and activated SCIM Identity Management integration. |
| idm_integration_reauth | Logged when an IT admin attempts to change the credentials for an activated SCIM Identity Management integration. |
| idm_integration_delete | Logged when an IT admin attempts to deactivate an activated SCIM Identity Management integration. |
SCIM DI User Events
| Event Name | Event Description |
|---|---|
| user_create_provision | Logged when JumpCloud tries to create a new user in service provider application. |
| user_update_provision | Logged when JumpCloud tries to update an existing user in service provider application. |
| user_deprovision | Logged when JumpCloud tries to change an existing user to inactive in the service provider application. |
| user_delete_provision | Logged when JumpCloud tries to delete an existing user in service provider application. |
| user_lookup_provision | Logged when JumpCloud encounters an issue when trying to lookup a user to determine if the user needs to be created or updated. |
SCIM DI Group Events
These DI events will only be present if SCIM Groups are supported.
| Event Name | Event Description |
|---|---|
| group_create_provision | Logged when JumpCloud tries to create a new group in service provider application. |
| group_update_provision | Logged when JumpCloud tries to update an existing group in service provider application. |
| group_delete_provision | Logged when JumpCloud tries to delete an existing group in service provider application. |
Removing the Integration
These are steps for removing the integration in JumpCloud. Consult your SP's documentation for any additional steps needed to remove the integration in the SP. Failure to remove the integration successfully for both the SP and JumpCloud may result in users losing access to the application.
To deactivate the IdM Integration
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
- Click confirm.
- If successful, you will receive a confirmation message.
To deactivate the SSO Integration or Bookmark
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Select the SSO or Bookmark tab.
- Scroll to the bottom of the configuration.
- Click Deactivate SSO or Deactivate Bookmark.
- Click save.
- If successful, you will receive a confirmation message.
To delete the application
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to delete.
- Check the box next to the application to select it.
- Click Delete.
- Enter the number of the applications you are deleting
- Click Delete Application.
- If successful, you will see an application deletion confirmation notification.
In this Article