黑料海角91入口

Help Center Home > Apps and Integrations > Integrate with Sparkpost

Integrate with Sparkpost

Use 黑料海角91入口 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 in Sparkpost from 黑料海角91入口 using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, and user identity in 黑料海角91入口 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 黑料海角91入口 administrator account.
  • 黑料海角91入口 SSO Package or higher or SSO add-on feature.
  • A SparkPost user account with administrator permissions.
  • A premier or enterprise Sparkpost plan.

Important Considerations

  • SSO must be configured to use SCIM.
  • Sparkpost SCIM API is based on version 2.0 of the聽SCIM standard.
  • If you need to update the SCIM token, you must deactivate the IdM integration, update 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 黑料海角91入口 Application Integration

  1. Log in to the .
  2. Go to聽USER AUTHENTICATION聽&驳迟;听SSO Applications.
  3. Click + Add New Application.
  4. Type the name of the application in the Search field and select it.
  5. Click Next.
  6. 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.

Note:

If this is a Bookmark Application, enter your sign-in URL in the Bookmark URL field.

  1. 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>.

Warning:

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.

  1. Click Save Application.
  2. 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 黑料海角91入口

  1. Create a new application聽or select it from the聽Configured Applications list.
  2. Select the聽SSO听迟补产.
  3. Add or change any attributes.
  4. 颁濒颈肠办听save.

Download the 黑料海角91入口 metadata file

  1. Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
  2. Select the SSO tab and click Export Metadata.
  3. The 黑料海角91入口-<applicationname>-metadata.xml will be exported to your local Downloads folder.

Tip:

Metadata can also be downloaded from the Configured Applications list. Search for and select the application in the list and then click Export Metadata in the top right corner of the window.

Download the certificate

  1. Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
  2. Select the SSO tab and click IDP Certificate Valid > Download certificate.

Tip:

The certificate.pem will download to your local Downloads folder.

To configure Sparkpost

  1. In Sparkpost, navigate to your email address > Account SSO Configuration.
  2. Click Create New SSO Group +.
  3. In Parse SAML 2.0 XML Config, click Upload and browse to and select the metadata downloaded in the previous section.
  4. If not parsed by the metadata, enter the following information:
    • Name - enter a name for your SSO Group.
    • SAML 2.0 Certificate - copy and paste the contents of the certificate downloaded in the previous section.
    • SAML 2.0 Endpoint - copy and paste the 黑料海角91入口 IDP URL.
  5. Click Save.

Authorizing User SSO Access

Users are implicitly denied access to applications. After you connect an application to 黑料海角91入口, 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

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
  3. Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
  4. Select the check box next to the group of users you want to give access.
  5. 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
  • Go to聽Applications and click an application tile to launch it
  • 黑料海角91入口 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

Note:

This varies by SP.

  • Login redirects the user to 黑料海角91入口 where the user enters their 黑料海角91入口 credentials
  • After the user is logged in successfully, they are redirected聽back to the SP and automatically logged in

Configuring the Identity Management Integration

To configure Sparkpost

  1. If you have not already done so, set up SSO for Sparkpost. 
  2. From your SparkPost dashboard, navigate to your Account Settings page by clicking on your username at the upper right corner of the screen.
  3. Under Single Sign-On click Generate SCIM token.
  4. Copy the SCIM token.

Warning:

The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the 黑料海角91入口 Password Manager, for future reference.

To configure 黑料海角91入口

  1. Create a new application or select it from the Configured Applications list.
  2. Select the Identity Management tab.
  3. Click Configure.
  4. You鈥檙e 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.

Note: Enterprise customers must replace with your SparkPost tenant name. Please see your TAM if you need assistance determining your callback URL.

  1. Click Activate. 
  2. You will receive a confirmation that the Identity Management integration has been successfully verified.
  3. Click save.
  4. You can now connect user groups to the application in 黑料海角91入口 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 黑料海角91入口 sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations. 

Learn about 黑料海角91入口 Properties and how they work with system users in our . 

Sparkpost User Attributes

黑料海角91入口 Property 黑料海角91入口 UI Field Name SCIM v2 Mapping Sparkpost Value
username Username userName userName
email 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 黑料海角91入口.

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application and click to open its configuration panel. 
  4. Select the Identity Management tab.
  5. Click manual import.
  6. Select the users you want to create in 黑料海角91入口 from the application from the list of users that appear. Users in the list have two import statuses:
    • 狈别飞听- user has not been imported
    • 滨尘辫辞谤迟别诲听- user has been imported and has an account in 黑料海角91入口

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.

  1. 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, 黑料海角91入口 will send you an email when your import is complete
  1. You can now connect and grant users access to all their 黑料海角91入口 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 黑料海角91入口 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 黑料海角91入口.

Note:

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 .

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 黑料海角91入口 tries to create a new user in service provider application.
user_update_provision Logged when 黑料海角91入口 tries to update an existing user in service provider application.
user_deprovision Logged when 黑料海角91入口 tries to change an existing user to inactive in the service provider application.
user_delete_provision Logged when 黑料海角91入口 tries to delete an existing user in service provider application.
user_lookup_provision Logged when 黑料海角91入口 encounters an issue when trying to lookup a user to determine if the user needs to be created or updated.

SCIM DI Group Events

Important:

These DI events will only be present if SCIM Groups are supported.

Event Name Event Description
group_create_provision Logged when 黑料海角91入口 tries to create a new group in service provider application.
group_update_provision Logged when 黑料海角91入口 tries to update an existing group in service provider application.
group_delete_provision Logged when 黑料海角91入口 tries to delete an existing group in service provider application.

Removing the Integration

Important:

These are steps for removing the integration in 黑料海角91入口. 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 黑料海角91入口 may result in users losing access to the application.

To deactivate the IdM Integration

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you鈥檇 like to deactivate and click to open its details panel. 
  4. Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
  5. Click confirm. 
  6. If successful, you will receive a confirmation message.

To deactivate the SSO Integration or Bookmark

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you鈥檇 like to deactivate and click to open its details panel. 
  4. Select the聽SSO or Bookmark聽tab.
  5. Scroll to the bottom of the configuration.
  6. Click Deactivate SSO or Deactivate Bookmark. 
  7. Click save. 
  8. If successful, you will receive a confirmation message.

To delete the application

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you鈥檇 like to delete.
  4. Check the box next to the application to select it.
  5. Click Delete.
  6. Enter the number of the applications you are deleting
  7. Click Delete Application.
  8. If successful, you will see an application deletion confirmation notification.
Back to Top

List IconIn this Article

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case