Subscribe to Support RSS FeedAutomatically provision, update and deprovision users in Sparkpost from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, and user identity in JumpCloud for Sparkpost. 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 Sparkpost integration.
Prerequisites
- A JumpCloud administrator account.
- A SparkPost user account with administrator permissions.
- A premier or enterprise Sparkpost plan.
- SAML SSO is configured and enabled.
- Sparkpost SCIM API is based on version 2.0 of the SCIM standard.
- If you have to change or renew your token, you must deactivate the IdM Integration, renew the token and then reactivate the integration.
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 its 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 connector at a later time.
Configuring the Identity Management Integration
To configure Sparkpost
- If you have not already done so, set up SSO for Sparkpost.
- From your SparkPost dashboard, navigate to your Account Settings page by clicking on your username at the upper right corner of the screen.
- Under Single Sign-On click Generate SCIM token.
- Copy the SCIM token.
Warning: The secret (token) may only be shown once. Copy it 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.
- Click Configure.
- You’re presented with two fields:
- Base URL: Enter the appropriate URL based on your location.
- For US-hosted customers, enter https://api.sparkpost.com/api/v1/users/scim/v2
- For EU-hosted customers, enter https://api.eu.sparkpost.com/api/v1/users/scim/v2
- For Enterprise customers, enter https://<host>.api.e.sparkpost.com/api/v1/users/scim/v2
- Token Key: Paste the token you generated when configuring SSO.
- Base URL: Enter the appropriate URL based on your location.
Note: Enterprise customers must replace with your SparkPost tenant name. Please see your TAM if you need assistance determining your callback URL.
- Click Activate.
- You will receive a confirmation that the Identity Management integration has been successfully verified.
- Click save.
- You can now connect user groups to the application in JumpCloud to provision the members of that group in Sparkpost . Learn how to Authorize Users to an Application.
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.
Sparkpost User Attributes
| JumpCloud Property | JumpCloud UI Field Name | SCIM v2 Mapping | Sparkpost Value |
|---|---|---|---|
| username | Username | userName | userName |
| Company Email | emails:value | emails | |
| active | Status | active | active |
| firstname | First Name | name.givenName | firstName |
| lastname | Last Name | name.familyName | lastName |
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 – The 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.
Removing the IdM Integration
To deactivate the IdM Integration
- Log in to the JumpCloud Admin Portal.
- Go to USER AUTHENTICATION > SSO.
- 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.
- You can now delete the application.
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 and click to open its details panel.
- Check the box for the application.
- 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