- \n
- A JumpCloud administrator account.<\/li>\n\n\n\n
- JumpCloud SSO Package or higher or SSO add-on feature.<\/li>\n\n\n\n
- A SparkPost user account with administrator permissions.<\/li>\n\n\n\n
- A premier or enterprise Sparkpost plan.<\/li>\n<\/ul>\n\n\n\n
<\/a>Important Considerations<\/strong><\/p>\n\n\n\n
- \n
- SSO must be configured to use SCIM.<\/li>\n\n\n\n
- Sparkpost SCIM API is based on version 2.0 of the\u00a0SCIM standard.<\/li>\n\n\n\n
- If you need to update the SCIM token, you must deactivate the IdM integration<\/a>, update the token, and then reactivate the integration.<\/li>\n<\/ul>\n\n\n\n
Attribute Considerations<\/strong><\/p>\n\n\n\n
- \n
- A default set of attributes are managed for users. See the Attribute Mappings<\/a> section for more details.<\/li>\n<\/ul>\n\n\n\n
Creating a new JumpCloud Application Integration<\/strong><\/h2>\n\n\n\n
- \n
- Log in to the JumpCloud Admin Portal<\/a>.<\/li>\n\n\n\n
- Go to\u00a0USER AUTHENTICATION\u00a0<\/strong>>\u00a0SSO<\/strong> Applications<\/strong>.<\/li>\n\n\n\n
- Click + Add New Application<\/strong>.<\/li>\n\n\n\n
- Type the name of the application in the Search <\/strong>field and select it.<\/li>\n\n\n\n
- Click Next<\/strong>.<\/li>\n\n\n\n
- In the Display Label<\/strong>, type your name for the application. Optionally, you can enter a Description<\/strong>, adjust the User Portal Image and choose to hide or Show in User Portal<\/strong>.<\/li>\n<\/ol>\n\n\n\n
![](\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/note-icon.png\")
<\/p><\/div>Note:<\/strong> \nIf this is a Bookmark Application, enter your sign-in URL in the Bookmark URL<\/strong> field.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
- \n
- Optionally, expand Advanced Settings<\/strong> to specify a value for the SSO IdP URL<\/strong>. If no value is entered, it will default to https:\/\/sso.jumpcloud.com\/saml2\/<applicationname><\/kbd>.<\/li>\n<\/ol>\n\n\n\n
![](\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/warning-icon.png\")
<\/p><\/div>Warning:<\/strong> \nThe SSO IdP URL<\/strong> 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.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
- \n
- Click Save Application<\/strong>.<\/li>\n\n\n\n
- If successful, click:\n
- \n
- Configure Application<\/strong> and go to the next section <\/li>\n\n\n\n
- Close<\/strong> to configure your new application at a later time <\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
Configuring the SSO Integration<\/strong><\/h2>\n\n\n\n
To configure JumpCloud<\/strong><\/h3>\n\n\n\n
- \n
- Create a new application<\/a>\u00a0or select it from the\u00a0Configured Application<\/strong>s list.<\/li>\n\n\n\n
- Select the\u00a0SSO<\/strong>\u00a0tab.<\/li>\n\n\n\n
- Add or change any attributes.<\/li>\n\n\n\n
- Click\u00a0save<\/strong>.<\/li>\n<\/ol>\n\n\n\n
Download the JumpCloud metadata<\/strong> file<\/strong><\/h4>\n\n\n\n
- \n
- Find your application in the Configured Applications<\/strong> list and click anywhere in the row to reopen its configuration window.<\/li>\n\n\n\n
- Select the SSO <\/strong>tab and click Export Metadata<\/strong>.<\/li>\n\n\n\n
- The JumpCloud-<applicationname>-metadata.xml<\/strong> will be exported to your local Downloads <\/strong>folder.<\/li>\n<\/ol>\n\n\n\n
![](\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/tip-icon.png\")
<\/p><\/div>Tip:<\/strong> \nMetadata can also be downloaded from the Configured Applications<\/strong> list. Search for and select the application in the list and then click Export Metadata<\/strong> in the top right corner of the window.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Download the certificate<\/strong><\/h4>\n\n\n\n
- \n
- Find your application in the Configured Applications<\/strong> list and click anywhere in the row to reopen its configuration window.<\/li>\n\n\n\n
- Select the SSO <\/strong>tab and click IDP Certificate Valid > Download certificate<\/strong>.<\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>Tip:<\/strong> \nThe certificate.pem will download to your local Downloads<\/strong> folder.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
To configure Sparkpost<\/strong><\/h3>\n\n\n\n
- \n
- In Sparkpost, navigate to your email address ><\/strong> Account SSO Configuration<\/strong><\/strong>.<\/li>\n\n\n\n
- Click Create New SSO Group +<\/strong>.<\/li>\n\n\n\n
- In Parse SAML 2.0 XML Config<\/strong>, click Upload <\/strong>and browse to and select the metadata downloaded in the previous section.<\/li>\n\n\n\n
- If not parsed by the metadata, enter the following information:\n
- \n
- Name <\/strong>– enter a name for your SSO Group.<\/li>\n\n\n\n
- SAML 2.0 Certificate<\/strong> – copy and paste the contents of the certificate downloaded in the previous section.<\/li>\n\n\n\n
- SAML 2.0 Endpoint<\/strong> – copy and paste the JumpCloud IDP URL<\/strong>.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
- Click Save<\/strong>.<\/li>\n<\/ol>\n\n\n\n
Authorizing User SSO Access<\/strong><\/h2>\n\n\n\n
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<\/strong> panel or from the Groups Configuration<\/strong> panel. <\/p>\n\n\n\n
To authorize user access from the Application Configuration panel<\/strong><\/h3>\n\n\n\n
- \n
- Log in to the <\/a>JumpCloud Admin Portal<\/a>.<\/li>\n\n\n\n
- Go to USER AUTHENTICATION > SSO<\/strong> Applications<\/strong>, then select the application to which you want to authorize user access.<\/li>\n\n\n\n
- Select the User Groups<\/strong> tab. If you need to create a new group of users, see Get Started: User Groups<\/a>.<\/li>\n\n\n\n
- Select the check box next to the group of users you want to give access.<\/li>\n\n\n\n
- Click save<\/strong>. <\/li>\n<\/ol>\n\n\n\n
To learn how to authorize user access from the Groups Configuration<\/strong> panel, see Authorize Users to an SSO Application<\/a>.<\/p>\n\n\n\n
Validating SSO user authentication workflow(s)<\/strong><\/h2>\n\n\n\n
IdP-initiated<\/strong> user workflow<\/strong><\/h3>\n\n\n\n
- \n
- Access the JumpCloud User Console<\/a><\/li>\n\n\n\n
- Go to\u00a0Applications<\/strong> and click an application tile to launch it<\/li>\n\n\n\n
- JumpCloud asserts the user’s identity to the SP and is authenticated without the user having to log in to the application<\/li>\n<\/ul>\n\n\n\n
SP-initiated<\/strong> user workflow<\/strong><\/h3>\n\n\n\n
- \n
- Go\u00a0to the SP application login – generally, there is either a special link or an adaptive username field that detects the user is authenticated through SSO<\/li>\n<\/ul>\n\n\n\n<\/p><\/div>Note:<\/strong> \n
This varies by SP.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
- \n
- Login redirects the user to JumpCloud where the user enters their JumpCloud credentials<\/li>\n\n\n\n
- After the user is logged in successfully, they are redirected\u00a0back to the SP and automatically logged in<\/li>\n<\/ul>\n\n\n\n
Configuring the Identity Management Integration<\/strong><\/h2>\n\n\n\n
To configure Sparkpost<\/strong><\/h3>\n\n\n\n
- \n
- If you have not already done so, set up SSO for Sparkpost. <\/li>\n\n\n\n
- From your SparkPost dashboard, navigate to your Account Settings<\/strong> page by clicking on your username at the upper right corner of the screen.<\/li>\n\n\n\n
- Under Single Sign-On<\/strong> click Generate SCIM token<\/strong>.<\/li>\n\n\n\n
- Copy the SCIM token.<\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>Warning:<\/strong> \nThe Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the JumpCloud Password Manager<\/a>, for future reference.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
To configure JumpCloud<\/strong><\/h3>\n\n\n\n
- \n
- Create a new application<\/a> or select it from the Configured Application<\/strong>s list.<\/li>\n\n\n\n
- Select the Identity Managemen<\/strong>t tab.<\/li>\n\n\n\n
- Click Configure<\/strong>.<\/li>\n\n\n\n
- You\u2019re presented with two fields:\n
- \n
- Base URL<\/strong>: Enter the appropriate URL based on your location.\n
- \n
- For US-hosted customers, enter\u00a0https:\/\/api.sparkpost.com\/api\/v1\/users\/scim\/v2<\/kbd><\/li>\n\n\n\n
- For EU-hosted customers, enter\u00a0https:\/\/api.eu.sparkpost.com\/api\/v1\/users\/scim\/v2<\/kbd><\/li>\n\n\n\n
- For Enterprise customers, enter\u00a0https:\/\/<host>.api.e.sparkpost.com\/api\/v1\/users\/scim\/v2<\/kbd><\/li>\n<\/ul>\n<\/li>\n\n\n\n
- Token Key<\/strong>: Paste the token you generated when configuring SSO.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>Note:<\/strong> Enterprise customers must replace with your SparkPost tenant name. Please see your TAM if you need assistance determining your callback URL.<\/p><\/div><\/div><\/div>\n\n\n\n
- \n
- Click Activate<\/strong>. <\/li>\n\n\n\n
- You will receive a confirmation that the Identity Management integration has been successfully verified.<\/li>\n\n\n\n
- Click save<\/strong>.<\/li>\n\n\n\n
- 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<\/a>.<\/li>\n<\/ol>\n\n\n\n
Attribute Mappings<\/strong><\/h2>\n\n\n\n
The following table lists attributes that JumpCloud sends to the application. See Attribute Considerations<\/a> for more information regarding attribute mapping considerations. <\/p>\n\n\n\n
Learn about JumpCloud Properties and how they work with system users in our API<\/a>. <\/p>\n\n\n\n
\nSparkpost User Attributes<\/h3>\n
\n\n\n
\n \n JumpCloud Property <\/th>\n \n JumpCloud UI Field Name <\/th>\n \n SCIM v2 Mapping <\/th>\n \n Sparkpost Value <\/th>\n <\/tr>\n \n \n username <\/td>\n \n Username <\/td>\n \n userName <\/td>\n \n userName <\/td>\n <\/tr>\n \n \n email <\/td>\n \n Company Email <\/td>\n \n emails:value <\/td>\n \n emails <\/td>\n <\/tr>\n \n \n active <\/td>\n \n Status <\/td>\n \n active <\/td>\n \n active <\/td>\n <\/tr>\n \n \n firstname <\/td>\n \n First Name <\/td>\n \n name.givenName <\/td>\n \n firstName <\/td>\n <\/tr>\n \n \n lastname <\/td>\n \n Last Name <\/td>\n \n name.familyName <\/td>\n \n lastName <\/td>\n <\/tr>\n <\/table>\n<\/div><\/div>\n\n\n\n Importing Users<\/strong><\/h2>\n\n\n\n
This functionality is helpful if users have already been created in the application but have not been created in JumpCloud.<\/p>\n\n\n\n
- \n
- Log in to the JumpCloud Admin Portal<\/a>.<\/li>\n\n\n\n
- For EU-hosted customers, enter\u00a0https:\/\/api.eu.sparkpost.com\/api\/v1\/users\/scim\/v2<\/kbd><\/li>\n\n\n\n
- For US-hosted customers, enter\u00a0https:\/\/api.sparkpost.com\/api\/v1\/users\/scim\/v2<\/kbd><\/li>\n\n\n\n
- Select the Identity Managemen<\/strong>t tab.<\/li>\n\n\n\n
- Under Single Sign-On<\/strong> click Generate SCIM token<\/strong>.<\/li>\n\n\n\n
- Go to\u00a0Applications<\/strong> and click an application tile to launch it<\/li>\n\n\n\n
- Go to USER AUTHENTICATION > SSO<\/strong> Applications<\/strong>, then select the application to which you want to authorize user access.<\/li>\n\n\n\n
- SAML 2.0 Certificate<\/strong> – copy and paste the contents of the certificate downloaded in the previous section.<\/li>\n\n\n\n
- Click Create New SSO Group +<\/strong>.<\/li>\n\n\n\n
- Select the SSO <\/strong>tab and click IDP Certificate Valid > Download certificate<\/strong>.<\/li>\n<\/ol>\n\n\n\n
- Select the SSO <\/strong>tab and click Export Metadata<\/strong>.<\/li>\n\n\n\n
- Select the\u00a0SSO<\/strong>\u00a0tab.<\/li>\n\n\n\n
- Close<\/strong> to configure your new application at a later time <\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
- If successful, click:\n
- Click Save Application<\/strong>.<\/li>\n\n\n\n
- Go to\u00a0USER AUTHENTICATION\u00a0<\/strong>>\u00a0SSO<\/strong> Applications<\/strong>.<\/li>\n\n\n\n
- Log in to the JumpCloud Admin Portal<\/a>.<\/li>\n\n\n\n
- A default set of attributes are managed for users. See the Attribute Mappings<\/a> section for more details.<\/li>\n<\/ul>\n\n\n\n