SOAP API
Quick answer
The SOAP API is the older XML-based web services interface, still used by some legacy IdentityIQ integrations but superseded by REST.
Key takeaways
- XML-based web services (legacy)
- Still present in IdentityIQ
- Superseded by the REST API
- Use only when a REST equivalent is missing
The SOAP API is IdentityIQ’s older, XML-based web-services interface. It predates the REST API and is still present for backward compatibility, but for new work the REST API is the recommended choice. Understanding SOAP mainly matters when maintaining or migrating legacy integrations.
What SOAP provided
IdentityIQ historically exposed SOAP web services for operations such as identity queries, provisioning and workflow invocation. These use XML request and response envelopes and a WSDL contract. Some long-lived integrations, particularly older middleware, still depend on them.
SOAP versus REST
| Aspect | SOAP | REST |
|---|---|---|
| Format | XML envelopes | JSON |
| Status | Legacy | Actively developed |
| Tooling | WSDL clients | SDKs, Postman, any HTTP client |
Migrating away from SOAP
Where a REST equivalent exists, migrate. REST brings better tooling, JSON payloads, and long-term support, and keeps your integration aligned with SailPoint’s direction. Keep SOAP only for functionality that genuinely has no REST counterpart, and document why.
Common pitfalls
- Building new integrations on SOAP when REST would serve.
- Brittle XML parsing tied to a specific envelope structure.
- Assuming SOAP will always be available, plan migrations proactively.
Want to learn this properly?
Our live, instructor-led SailPoint Training covers this hands-on, with real projects and a certification path.
Check your understanding
What format does the SOAP API use?
- A. The REST API.
- B. XML-based web services.
- C. No, REST supersedes it; use SOAP only for legacy needs.
Show answer
B. XML-based web services.
XML-based web services.
Is SOAP the recommended interface?
- A. XML-based web services.
- B. No, REST supersedes it; use SOAP only for legacy needs.
- C. The REST API.
Show answer
B. No, REST supersedes it; use SOAP only for legacy needs.
No, REST supersedes it; use SOAP only for legacy needs.
What should new integrations use?
- A. No, REST supersedes it; use SOAP only for legacy needs.
- B. XML-based web services.
- C. The REST API.
Show answer
C. The REST API.
The REST API.