Integrating SailPoint with Nutshell

Nutshell is a customer relationship management (CRM) and sales automation platform that helps businesses manage contacts, track leads and deals through customizable pipelines, automate email marketing, collaborate as a team, and measure performance with reports and analytics, while also offering integrations and APIs for automation and custom workflows. This document provides instructions to configure a new direct connection to a Nutshell source. For a reference to the terminology specific to SailPoint products, refer to Source and Connector Definitions.

Supported Features

The Nutshell connector supports the following:

Account Management

• Aggregate Accounts

Entitlement Management

• Aggregate Teams

Prerequisites

Ensure the following prerequisites are met before proceeding with the configuration:

• Generate a Nutshell API Key:
  1. Go to Nutshell Settings > Connections > API Keys > Add API Key.
  2. Provide a name for the key.
  3. Select permissions: API + User Impersonation.

  4. Copy the generated API key.

     Important

     Once created, copy the key immediately - it cannot be retrieved again.

Required Permissions

• If you are logged in with an Administrator account, you may proceed directly with API key creation and usage. In this case, the service account configuration described below is not required.
• In Nutshell, API access is permission-based rather than role-based.
• Access to user and team data via the API is restricted as follows:
  • Only users with Administrator privileges or the “The employee can see all data in Nutshell” permission can:
    • Retrieve the complete list of users
    • Retrieve the complete list of teams
    • Perform read operations across the entire account
• Nutshell does not provide a dedicated read-only API role. Read access is determined solely by the permissions assigned to the user associated with the API key.

API Key Ownership

• Any user may own an API key (Personal Access Token).
• API keys must be generated by an Administrator from Settings > API Keys.

• Each API key inherits the permissions of the user to whom it is assigned.

  Note

  Once created, the API key operates with the same access level as the associated user account.

Service Account Configuration (Non-Administrator Accounts)

• If you cannot have full administrative privileges, the recommended approach is to use a service account.

  1. Create a service account
     • Role: Standard User
     • Permission: The employee can see all data in Nutshell (enabled)
  2. Ask an Administrator to generate the API key
     • Admin goes to Settings > API Keys
     • Admin creates the API key and assigns it to the service account
  3. Use the API key for integrations
     • The API key provides read access based on the service account’s permissions

  Note

  Non-administrator users cannot create API keys. They may only use API keys created by an Administrator.

Permission Reference (Non-Administrator Users)

• The employee can see all data in Nutshell, permission should be assigned to non-administrator users who require visibility into all companies, people, leads, users, and teams across the Nutshell account.
• For more information about non-administrator user account roles and permissions, refer to the Nutshell Help Center.