Prerequisites
- Deel administrator account
- A JumpCloud API key to connect Deel and JumpCloud
Important Considerations
- Syncs from Deel to JumpCloud happen automatically every night.
- Syncs can be triggered to occur at any time from the JumpCloud app in the Deel console.
Preparing for the integration
To create a new JumpCloud Admin account for the Deel Integration
- Log in to the JumpCloud Administrator Portal with an administrator account: https://console.jumpcloud.com.
- Click your initials in the top right corner.
- Select Administrators.
- Click the green + icon.
- Enter a first name, such as ‘Deel’.
- Enter a last name, such as ‘Integration’.
- Enter the email address you want associated with this account.
- Select Administrator for the Role.
- It is recommended that you enable Multi-factor Authentication Required.
- Click Save.
- Go to the inbox of the email address specified for this account.
- Find the JumpCloud Administrator Account Setup email.
- Click Setup Account in the email.
- Enter a password in the Password and Confirm Password fields.
- Select the box to agree to the Terms of Use.
- Click Reset Password.
- If the option to require Multi-factor Authentication was enabled, do the following:
- Follow the instructions to download JumpCloud Protect if you don’t have it or another Authenticator app.
- Otherwise, click I Have An App.
- Add the JumpCloud account.
- Verify the TOTP code from the Authenticator app.
- Click Submit.
To get your JumpCloud API Key
- Log in to the JumpCloud Admin Portal with the administrator account you want to use to generate the API key for this integration.
- Click the initials in the top right corner.
- Select My API Key.
- Copy the API Key and store it securely, or leave this tab open while you complete the integration configuration steps in Deel.
Connecting the JumpCloud app in Deel
- Login to Deel with an administrator account.
- Click Apps & Integration from the left navigation menu.
- Search for and select JumpCloud.
- Click Connect.
- Paste the API key you copied in the steps above.
- Click Connect.
- Click OK on the connection success notification window.
Syncing users data from Deel to JumpCloud
An automatic nightly sync occurs that will create new users, update existing users, and suspend users who have been marked as terminated. You can trigger an immediate sync between Deel and JumpCloud at any time.
You may want to trigger an immediate sync in the case of employee terminations or role and department changes.
To immediately sync changes from Deel to JumpCloud
- Login to Deel with an administrator account.
- Click Apps & Integration from the left navigation menu.
- Select the Connected Apps tab.
- Find the JumpCloud app.
- Click Manage.
- Click Sync JumpCloud,
Deel User Attributes
Deel Value | JumpCloud Attribute | JumpCloud UI Field Name | Notes |
---|---|---|---|
Work email | Company Email | Required. Users will not sync if a work email address is not defined. (max length 1024) | |
N/A | username | Username | The user name is set to {firstname.lastname}. If the username already exists in your JumpCloud organization, a number will be appended to the last name (e.g., alpha.zed1) |
First Name | firstname | First Name | |
Last Name | lastname | Last Name | |
Full Name | displayName | Display Name | |
Active (boolean) | state | N/A | Users are created as staged or active when active is true. Users are suspended when active is sent as false. |
Job Title | jobTitle | Job Title | |
Department | department | Department | |
Work Location | location | Location | |
Team | costCenter | Cost Center | |
Worker Type | employeeType | Employee Type | |
Entity | company | Company | |
Profile ID | employeeIdentifier | Employee ID |
Managing user access and access policies for JumpCloud managed resources
Once users are created in JumpCloud, you can grant them access to any of the resources connected to JumpCloud from a device to applications, networks, etc. User, device, and policy groups allow you to more efficiently assign resources to users and control the level of permissions they are given. Access policies allow you to control how, on what device, and from where they can access their assigned resources.
All user access and access policy management for JumpCloud managed resources is done directly in the JumpCloud Admin Portal or through the JumpCloud API. For more information see, Get Started: Users, Get Started: User Groups, and Get Started: Conditional Access Policies.
Managing devices and policies
Using JumpCloud's device management features will allow you to control settings on your devices, including Firewalls, Disk Encryption, Security Settings and common compliance policy groups.
All device and policy management actions are done directly in the JumpCloud Admin Portal or through the JumpCloud API. For more information, see Get Started: Devices and Get Started: Policies.
Activating a user in JumpCloud
A user in the Staged user state in JumpCloud does not have access to their assigned resources. Once a user has been assigned a device, policies, and all other needed JumpCloud managed resources, the user will need to be activated in JumpCloud to gain access to those resources. For more information about activating a user, read Manage User States.
- Log in to the JumpCloud Admin Portal with an administrator account.
- Go to USER MANAGEMENT > Users.
- Select the user you want to activate.
- Click the dropdown menu next to Staged above the Security Status section in the left panel.
- Select Activate.
- Click Schedule Activation to activate the user on a future date and time or Activate Now to activate the user immediately.
- Click Save.
For Scheduled Activation, the time must be at least one hour in the future.
- Select and populate the Send email to field to notify the user of their JumpCloud account activation.
- Click Save.
Troubleshooting
Coming soon!