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

Examples

Worked examples of common SailPoint API calls.

Quick answer

Practical examples: fetch an identity, submit an access request, list a certification, and search entitlements, the calls you will make most.

Key takeaways
  • Fetch and search identities
  • Submit access requests
  • Read certifications and campaigns
  • Search entitlements and roles

The fastest way to learn the SailPoint API is by working through the calls you will actually make most: fetching and searching identities, submitting access requests, and reading certification and audit data. Each is a straightforward authenticated REST call, usually with a filter.

Search for an identity

GET /v3/public-identities?filters=alias eq "jdoe"
Authorization: Bearer <token>

Submit an access request

POST /v3/access-requests
Authorization: Bearer <token>
Content-Type: application/json

{
  "requestedFor": ["<identityId>"],
  "requestType": "GRANT_ACCESS",
  "requestedItems": [{ "type": "ACCESS_PROFILE", "id": "<id>" }]
}

Read certification data

Pull campaign and certification detail to build reporting or feed downstream systems, combining filtering to scope the data and pagination to retrieve it in full.

Turn these into robust code

Start from these patterns and add the production essentials: obtain and refresh an OAuth token, filter server-side, paginate large results, and back off on 429/5xx. The official SDKs bundle most of this for you.

Common pitfalls

  • Copying examples without adding pagination for bulk reads.
  • Hard-coding IDs instead of looking them up.
  • Skipping error handling that production needs.

Practice challenge

+0 XPStreak ×0
Question 1 of 3
What are the most common API calls?

Frequently asked questions

What does the term Examples refer to in SailPoint?
The fastest way to learn the SailPoint API is by working through the calls you will actually make most: fetching and searching identities, submitting access requests, and reading certification and audit data. Each is a straightforward authenticated REST call, usually with a filter.
What is the practical takeaway on Examples?
Pull campaign and certification detail to build reporting or feed downstream systems, combining filtering to scope the data and pagination to retrieve it in full.
What is worth remembering about Examples in practice?
Start from these patterns and add the production essentials: obtain and refresh an OAuth token, filter server-side, paginate large results, and back off on 429 / 5xx.
What tends to go wrong with Examples?
Copying examples without adding pagination for bulk reads. Hard-coding IDs instead of looking them up. Skipping error handling that production needs.
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