IT CanvassTalk to an advisor
APIs & integration · LessonBy , SailPoint Trainer, 7 yrs · Published · IdentityIQ 8.4 · all levels

REST API

SailPoint's REST API for identities, access requests, certifications and more.

Quick answer

The REST API is the primary programmatic interface to SailPoint, returning JSON over HTTPS with OAuth-based authentication.

Key takeaways
  • JSON over HTTPS, OAuth secured
  • Covers identities, access, certifications, sources
  • Supports filtering, sorting and pagination
  • The modern way to integrate with SailPoint

The REST API is the primary programmatic interface to SailPoint. It returns JSON over HTTPS, is secured with OAuth, and exposes the objects you work with in the UI, identities, accounts, entitlements, access requests, certifications, sources, so that automation, custom portals and integrations can do anything a user can, at scale.

What the REST API covers

The API is broad and versioned. Typical resource areas include public identities and full identity detail, accounts and entitlements, access requests and their status, certifications and campaigns, sources/applications, and configuration objects. In SailPoint Identity Security Cloud these are the well-documented v3/beta endpoints; IdentityIQ exposes its own REST API for the same purposes.

Authentication

Every call carries an OAuth bearer token. A service integration obtains a token using the client-credentials grant, then sends it on each request:

curl -H "Authorization: Bearer $TOKEN" \
  "https://tenant.api.identitynow.com/v3/public-identities?filters=alias eq \"jdoe\""

Working with collections

List endpoints support server-side filtering, sorting and pagination. Always filter to what you need and page through large result sets rather than pulling everything, this is faster, cheaper and avoids rate limits. Read the total count from the response headers to know when you have all records.

Why REST over SOAP

The REST API is the modern, actively-developed interface. It uses JSON, integrates with every language and tool, is well documented, and is what the SDKs and Postman collections target. Reserve the older SOAP interface for legacy integrations that have no REST equivalent.

Practical guidance

  • Cache and refresh tokens rather than authenticating on every call.
  • Handle 429 (rate limit) and 5xx with exponential backoff.
  • Prefer the official SDKs, which wrap auth, pagination and retries.

Common pitfalls

  • Pulling entire collections instead of filtering server-side.
  • Ignoring pagination, missing records beyond the first page.
  • Hard-coding tokens instead of obtaining them via OAuth.

Practice challenge

+0 XPStreak ×0
Question 1 of 3
What format does the REST API return?

Frequently asked questions

What does the term REST API refer to in SailPoint?
The REST API is the primary programmatic interface to SailPoint.
What is worth remembering about REST API in practice?
Typical resource areas include public identities and full identity detail, accounts and entitlements, access requests and their status, certifications and campaigns, sources/applications, and configuration objects.
What is another point to note about REST API?
List endpoints support server-side filtering, sorting and pagination.
What tends to go wrong with REST API?
Pulling entire collections instead of filtering server-side. Ignoring pagination, missing records beyond the first page. Hard-coding tokens instead of obtaining them via OAuth.
Want this with a live instructor and a lab tenant?
SailPoint Developer training →
Already working on SailPoint and stuck on a live ticket?Get an expert SailPoint developer on screen-share to finish your daily tasks with you. Deliver on time, protect your reputation and your job. Monthly support only, no task-wise plans.Task assigned · no idea where to startStill stuck · your job on the lineExpert joins your screenDelivered on timeExplore On Job Support