Getting Started
Authentication
API Versioning
V3 API Standard Collection Parameters
Access Requests
Account Activities
Certifications
Certification Summaries
Public Identities
Public Identities Config
Requestable Objects
Saved Search
Scheduled Search
Search
Reference
Models
IAI Recommendations
IAI Peer Group Strategies
Access Request Approvals
Access Requests
Account Activities
Accounts
Certifications
Certification Campaigns
Lifecycle States
Managed Clusters
Non-Employee Lifecycle Management
Notifications
OAuth Clients
Password Dictionary
Personal Access Tokens
Public Identity Config
Requestable Objects
Role Insights
Service Desk Integration
Sources
Tagged Objects
Task Management
Triggers
SOD Policy
Reference
Models

Get Started with SailPoint APIs

NOTE: To use SailPoint APIs, you must have an org provisioned and bootstrapped with identities, sources/applications, and entitlements/access profiles/roles.

To get started, you will need an API client:

  • As an ORG_ADMIN, browse to your API Management Admin Page on https://{org}.identitynow.com/ui/admin/#admin:global:security:apimanagementpanel and create an API client.
  • Retrieve an Access Token from https://{org}.identitynow.com/ui/session.
  • Use POST https://{org}.api.identitynow.com/beta/oauth/client.

How to Use the Developer Portal

For more information about SailPoint Platform authentication, see API Authentication

  • SailPoint supports API v3, and beta. Use the most recent version of the API, when possible.
  • There is a limitation of 100 requests per access token per 10 seconds for V3 API calls through the API gateway.
  • Each API resource requires a specific level of authorization attached to your accessToken. Please review the authorization constraints for each API resource.
  • For detailed information about using /search API, see this Compass Article.

Use an API Tool

From the SailPoint, and Early Access header pages, you can download the full specifications and import them into an API tool, such as POSTMAN.

Use Request Makers in the Developer Portal

This portal includes HTTP request makers to invoke APIs without using a tool such as POSTMAN. You must retrieve an accessToken and add it in the header for as a Bearer token.

The Code Generation tab for each HTTP Request Maker provides code examples of how to invoke the API, e.g. CURL, Python, etc.