Use 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. Provision, update, and deprovision users in Slack in real-time from JumpCloud using the Identity Management (SCIM) integration.
Read this article to learn how to setup the Slack integration.
Prerequisites
- A JumpCloud administrator account
- JumpCloud SSO Package or higher or SSO à la carte option
- A Business+ or Enterprise Grid plan
- A Slack Administrator or Workspace Owner account
- Your Slack domain and team name
Important Considerations
- The Allow users to choose their own display name setting in Slack must be disabled
JumpCloud calculates the displayname attribute for all SCIM users. As a result, this setting must be disabled in Slack or the SCIM integration will fail.
- We recommend that you activate SSO for Slack prior to creating an Identity Management integration with Slack to simplify the login process for your users and reduce the number of usernames and passwords they have to remember
- If you choose to not activate SSO, deselect Show this application in the User Portal in the General Info tab of the Slack configuration window. This will hide the inactive Slack tile from your users
- SAML is the recommended method for managing secure user authentication into Slack
- Once you’ve set up SSO, members that are required to sign in with SSO will get an email. The email will prompt members to bind their Slack accounts with JumpCloud. Members will have 72 hours to bind their account before their link expires
- The email address of the JumpCloud accounts must correspond to the email address associated with the Slack Plus accounts
- JumpCloud Session Settings are not passed into Slack, session duration will need to be set in Slack as well
- If you are setting up Slack Identity Management for an organization that is managed from the Multi-Tenant Portal (MTP), you need to use a local JumpCloud administrator from that particular organization to do so
- Users that are created in Slack remain in an ‘Inactive’ state until they log in to their JumpCloud User Portal and launch Slack using their JumpCloud credentials
- If you delete an integrated Slack application from your Applications list, the Slack application is removed from JumpCloud, but any previously bound users remain active in Slack. Additionally, these users can log in to Slack with the password they used prior to your deletion of the Slack application from your JumpCloud account
- Users can’t be permanently deleted from Slack, they can only be deactivated
- If you try to provision a user with a duplicate email address, it will fail. Even if the existing user has been previously deactivated in Slack, the existing user email address has to be manually updated in Slack to unbind the email and allow it to be reprovisioned
- When creating a new user, make sure that nothing is invalid in the custom profile, otherwise all profile fields will be dropped
- Creating or deactivating a Multi-Channel Guest is only available on the Enterprise Grid Plan
- When creating a Single-Channel Guest, or creating a guest on the Business+ plan, you can create a member and then change their role to a guest
- Group mention handles (@group) can’t be set via the SCIM provisioning API
- Subteams that are automatically generated by Slack, like “Team Admins,” can’t be updated via the SCIM API
- The SCIM API is rate limited. If your requests are being limited, an “HTTP: 429” error will be returned
- Don't add the same user group to multiple Slack connectors in JumpCloud. If you do, users who are members of that user group will be deactivated in the application if one of the connectors is removed from the user group
- Slack maps the value sent for the 'title' user attribute to both the ‘title’ and 'What I do’ field. If users have been given the ability to change the "What I do value in Slack", their change will be overridden whenever a user update is sent via the SCIM integration. The mapping to the 'What I do' field is completely controlled by Slack
- Groups are supported. If the Enable management of User Groups and Group Membership in this application is enabled, groups cannot be added back to the Slack application after being removed. Removing a group after it has been added to the Slack application in JumpCloud typically results in the group being disabled in Slack. Adding the group back to the Slack application in JumpCloud results in errors and fails, because there is no functionality in the SCIM protocol for enabling disabled groups
Attribute Considerations
- A default set of attributes are managed for users. See the Attribute Mappings section for more details
- Slack does not store type for addresses. The type field will be used to determine which address is the "primary address" if the request does not specify one, however the type is not stored
- Username values and channel name values must be unique and share the same namespace. For example, you can't have a username for @general if you also have a #general channel in the Slack workspace
- There is a limit of 50 custom profile fields, which includes fields set via the SCIM API. If your request would cause more than 50 fields to exist, the call will fail with a unable_to_create_team_profile_fields error
- username:
- You can't use special characters, such as [email protected]
- Must be less than 21 characters
- Must be unique
- displayName:
- Values aren't entirely unique; for example, two users can have the same display name
- You can use non-English characters, spaces, and capitalization
- You can include periods ( . ), underscores ( _ ), hyphens ( - ), apostrophes ( ' ), brackets ( { }, [ ] ) and separators ( , / ; )
- Slack only allows matching with the attributes userName and email
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 Configured Applications list.
- Select the SSO tab.
- Replace any instances of YOURDOMAIN and TEAMNAME with your Slack values.
- Add any desired 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 Slack
- Login your Slack account as a Workspace Owner.
- Go to Settings & administration > Workplace settings.
- Select the Authentication tab, then click Configure for SAML Authentication.
- Enter the following information:
- SAML 2.0 Endpoint (HTTP) - enter the JumpCloud IdP URL
- Identity Provider Issuer - enter the JumpCloud IDP Entity ID
- Certificate - copy and paste the contents of the certificate downloaded in the previous section
- Under Advanced Options:
- Use the default value for the Service Provider Issuer (e.g., https://<teamname>.slack.com)
- Uncheck Assertions Signed
If Assertions Signed is left enabled, you will receive a "The Assertion of the SAML Response is not signed. Please check your [IDP] settings." error message.
- Under Settings, ensure Allow users to choose their own display name is deselected.
- Select any other of the desired options for SAML Authentication for users and workspace.
- Click Save Configuration.
It's recommended to use It’s optional for the Authentication for your workspace must be used by until the SAML configuration is fully tested. This will allow you to use both – username/password and SAML authentication options.
- In the Customize section in the Sign In Button Label field, enter JumpCloud.
- Click Save Configuration.
- You will then be sent to the JumpCloud User Portal to perform an initial SSO login and confirm the configuration.
- After you have completed SSO as the administrator account, your authentication settings will be verified and enabled.
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
Using JIT Provisioning
Additional attributes are required to use JIT provisioning. JIT required attributes are prepopulated and are on by default to enable JIT provisioning. You can’t edit the JIT required service provider attributes. You can customize the JumpCloud attribute name and the constant value for JIT required attributes. Toggle off the attributes to opt out of sending the attributes in the SAML assertion
To complete the provisioning process
- Authorize a user’s access to the application in JumpCloud.
- Have the user log in to the application using SSO. The SAML assertion passes from JumpCloud to the service provider, and gives the service provider the information it needs to create the user account.
Configuring the Identity Management Integration
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab and click Configure.
- You're redirected to Slack to give JumpCloud permission to access your organization's Slack workspace. Click Allow.
- You receive a confirmation that the Identity Management integration has been successfully verified.
- Copy the token that is generated.
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.
- Select Slack from the Configured Applications list and select the Identity Management tab.
- Deselect Enable management of User Groups and Group Membership in this application if you do not want to provision, manage, and sync groups.
- Click Configure.
- Paste the token that was generated and then click activate.
- If successful, click save.
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.
Slack User Attributes
Slack User Attribute | JumpCloud User Attribute | Notes |
---|---|---|
external_id | id | |
username | username | |
password | password | Only when cleartext is available |
name.givenName | firstname | |
name.familyName | lastname | |
name.middleName | middlename | |
name.displayName | displayname | Calculated: firstname + lastname |
emails[type='work',primary=true].Email | ||
active | !suspended && !passwordExpired | |
title | jobTitle | |
location | meta.location | |
addresses[].type | addresses[].type | |
addresses[].streetAddress | addresses[].streetAddress | |
addresses[].locality | addresses[].locality | |
addresses[].region | addresses[].region | |
addresses[].postalCode | addresses[].postalCode | |
addresses[].country | addresses[].country | |
phoneNumbers[].type | phoneNumbers[].type | |
phoneNumbers[].value | phoneNumbers[].value | |
employeeNumber | employeeIdentifier | |
department | department | |
organization | company |
Slack Group Attributes
Slack Group Attribute | JumpCloud Group Attribute | Notes |
---|---|---|
external_id | id | |
Name | name | |
Members | members | Multi-valued |
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.