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. Automatically provision, update and deprovision users and groups in Perimeter81 from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for Perimeter81. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.
Read this article to learn how to integrate with Perimeter81.
Prerequisites
- A JumpCloud administrator account.
- JumpCloud SSO Package or higher or SSO à la carte option.
- A Perimeter81 user account with administrator permissions.
- Your Perimeter81 workspace name.
Important Considerations for SCIM
- SAML SSO must be enabled.
- If you need to update your token, you must deactivate the IdM integration, update the token, and then reactivate the IdM integration.
- When users are deactivated or removed, they will be deleted within Perimeter 81 which prevents the user from logging in and frees up a user license.
- The ‘Name’ field does not support the following special characters, such as “@”, “()”, “#”, “$”, “.”, and “!”. Only ‘a-z’, ‘A-Z’, and ‘0-9’ are supported.
- Perimeter 81 uses the email address of each user as the unique identifier of the tenant. This means that the SCIM integration doesn’t support email modification and updates.
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.
- Navigate 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.
- 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 YOUR_WORKSPACE with your Perimeter81 workspace name.
- 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 Perimeter81
- Sign in to your Perimeter 81 company site as an administrator.
- Go to Settings > Identity Providers > Add Provider.
- Select SAML 2.0 Identity Providers and click Continue.
- Enter the following information:
- Sign In URL – copy and paste the JumpCloud IDP URL.
- Domain Aliases – enter your domain alias value.
- X509 Signing Certificate – select Upload PEM/CERT File, browse to and upload the certificate downloaded in the previous section.
- Click Done.
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 authentication workflow(s)
IdP Initiated
- Access the JumpCloud User Console.
- Select the application’s tile.
- The application will launch and login the user.
SP Initiated
- Navigate to your Service Provider application URL.
- You will be redirected to log in to the JumpCloud User Portal.
- The browser will be redirected back to the application and be automatically logged in.
Configuring the Identity Management Integration
To configure Perimeter81
- Sign in to your Perimeter 81 company site as an administrator.
- Navigate to Settings -> Identity Providers and select Turn On next to SCIM Integration.
- Click Settings and then Generate Token.
- Click Copy Token.
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
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab and click Configure.
- In the Token Key field, paste the token generated in the previous section.
- Click Activate.
- If successful, click save.
- You will receive a confirmation that the Identity Management integration has been successfully verified.
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.
Perimeter81 User Attributes
JumpCloud Property | JumpCloud UI | SCIM v2 Mapping | Perimeter81 Value |
Company Email | emails.value | Email address | |
title | Job Title | title | Title |
firstname | First Name | name.givenName | First Name |
lastname | Last Name | name.familyName | Last Name |
active | Status | active | Active |
phoneNumbers.value | Work Phone | phoneNumbers [work] | Personal contact number |
phoneNumbers.value | Work Phone | phoneNumbers [mobile] | Personal contact number |
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
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
- 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 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.