API overview
The APIs that let you integrate with IdentityIQ and Identity Security Cloud: REST, SCIM and the internal Java API.
IdentityIQ exposes a SCIM 2.0 REST API and a set of internal REST and Java APIs for integration and automation. Identity Security Cloud offers a broader, versioned REST API (v3/beta). Use these to request access, read identities, launch tasks and integrate other systems programmatically.
- IdentityIQ exposes SCIM 2.0 plus internal REST/Java APIs
- Identity Security Cloud has a versioned REST API
- Use APIs for access requests, reads and automation
- OAuth or API tokens secure the calls
- Prefer supported APIs over direct database access
The APIs and integration module covers how to drive SailPoint programmatically, primarily through its REST API, so you can automate governance, build custom portals, and integrate with the wider ecosystem. This is where SailPoint stops being a UI and becomes a platform.
What this module covers
The module documents authentication (OAuth), the REST API and its conventions (filtering, pagination, rate limits, errors), the older SOAP interface, SCIM, SDKs, webhooks and Postman. Each has its own detailed page.
What you will find here
- REST API and OAuth authentication.
- Filtering, pagination, rate limits and errors.
- SCIM, SDKs, webhooks and Postman.
- SOAP for legacy needs.
How to use it
Begin with authentication and the REST API basics, prototype in Postman, then move to the SDK for production code. Apply filtering and pagination from the start, and handle rate limits and errors defensively.
Common pitfalls
- Pulling whole collections instead of filtering and paginating.
- Hard-coding tokens instead of using OAuth.
- Ignoring rate limits and building brittle integrations.