SailPoint Python SDK Template

A template project for the SailPoint Python SDK. It is initialized using the SailPoint CLI and provides working examples of common Identity Security Cloud API calls using the Python SDK.

Prerequisites

• Python 3.7+ — check with python --version (download)
• SailPoint CLI installed and configured (installation guide)
• A SailPoint Identity Security Cloud tenant
• A Personal Access Token (PAT) with a client ID and client secret (creating a PAT)

Getting Started

1. Create the project

Use the SailPoint CLI to create a new project from this template:

sail sdk init python py-example

This creates the following structure:

py-example/
├── requirements.txt
└── sdk.py

2. Navigate into the project

cd py-example

3. Install dependencies

pip install -r requirements.txt

Tip: Use a virtual environment to isolate dependencies: python -m venv .venv then source .venv/bin/activate (Linux/macOS) or .venv\Scripts\activate (Windows).

4. Configure the SDK

The SDK needs credentials to authenticate with your SailPoint tenant. Generate a config.json file using the CLI:

sail sdk init config

If you have multiple environments configured in the CLI, specify which one to use:

sail sdk init config --env devrel

This creates a config.json in the project directory:

{
  "ClientId": "your-client-id",
  "ClientSecret": "your-client-secret",
  "BaseURL": "https://[tenant].api.identitynow.com"
}

You can also use environment variables (SAIL_BASE_URL, SAIL_CLIENT_ID, SAIL_CLIENT_SECRET) instead of a config file.

Tip: Add config.json to your .gitignore so credentials are not committed to version control.

5. Run the project

python sdk.py

What's Included

The sdk.py file contains several example operations demonstrating common SDK usage:

Operation	API	SDK Class
List transforms	V3	TransformsApi
List access profiles	V3	AccessProfilesApi
Search identities (with pagination)	V3	SearchApi + Paginator
Paginate accounts	V3	AccountsApi + Paginator
List governance groups (workgroups)	Beta	GovernanceGroupsApi

You can extend the script with any V3 or Beta API endpoints.

Customization

• Change the API — swap TransformsApi for another API such as AccountsApi or SourcesApi.
• Change the method — use different methods on the API client for your use case.
• See the Getting Started guide for more examples.

Resources

• Python SDK Documentation
• Python SDK Getting Started Guide
• SailPoint CLI Documentation
• Identity Security Cloud API Reference
• Python SDK GitHub Repository
• SailPoint Developer Community