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

SOAP API

The legacy SOAP/XML web services interface in IdentityIQ.

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

AspectSOAPREST
FormatXML envelopesJSON
StatusLegacyActively developed
ToolingWSDL clientsSDKs, 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.

Practice challenge

+0 XPStreak ×0
Question 1 of 3
What format does the SOAP API use?

Frequently asked questions

What does the term SOAP API refer to in SailPoint?
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 is the practical takeaway on SOAP API?
IdentityIQ historically exposed SOAP web services for operations such as identity queries, provisioning and workflow invocation.
What is worth remembering about SOAP API in practice?
Some long-lived integrations, particularly older middleware, still depend on them.
What tends to go wrong with SOAP API?
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 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