Examples · LessonBy Imran Q, SailPoint Trainer, 7 yrs · Published · IdentityIQ 8.4 · all levels
REST examples
Example REST API calls against SailPoint.
Quick answer
These REST examples show authenticating and calling common endpoints to read identities and submit requests.
Key takeaways
- Auth then call pattern
- Identity search example
- Access request example
- Add pagination for bulk
These REST examples show the calls you make most against SailPoint, authenticated with an OAuth bearer token, usually with a filter, and paginated for bulk reads.
Search identities
curl -H "Authorization: Bearer $TOKEN" \
"https://tenant.api.identitynow.com/v3/public-identities?filters=department eq Finance"Submit an access request
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d BODY https://tenant.api.identitynow.com/v3/access-requests
# BODY:
# { "requestedFor": ["<id>"], "requestType": "GRANT_ACCESS",
# "requestedItems": [ { "type": "ACCESS_PROFILE", "id": "<id>" } ] }Paginate a large list
# increase offset by limit until offset >= the total-count header
curl -H "Authorization: Bearer $TOKEN" \
"https://tenant.api.identitynow.com/v3/accounts?limit=250&offset=0"Guidance
- Obtain and refresh the token via OAuth; do not hard-code it.
- Filter server-side and paginate large results.
- Back off on 429/5xx.
Common pitfalls
- Only reading the first page.
- No filter, pulling entire collections.
- Ignoring rate limits.
Practice challenge
+0 XPStreak ×0
Question 1 of 3
What do REST examples show?
Frequently asked questions
What does the term REST examples refer to in SailPoint?
These REST examples show the calls you make most against SailPoint, authenticated with an OAuth bearer token, usually with a filter, and paginated for bulk reads.
What is the practical takeaway on REST examples?
Filter server-side and paginate large results. Back off on 429/5xx.
What tends to go wrong with REST examples?
Only reading the first page. No filter, pulling entire collections. Ignoring rate limits.
Want this with a live instructor and a lab tenant?