The SOAP Web Services API lets other systems connect to and exchange data with Mosaic. You can only use this API when your Mosaic environment is set up to sign in with a username and password.
How sign-in affects the SOAP Web Services API
The SOAP Web Services API checks a username and password each time another system connects to it. Because of this, you can only use it when your Mosaic environment is configured to sign in with a username and password.
If your Mosaic environment uses single sign-on instead — such as SAML or OIDC — you can't use the SOAP Web Services API. Any system that tries to connect won't be able to sign in, and the connection fails.
Sign-in methods and SOAP Web Services API compatibility
How your Mosaic signs in | Can the SOAP Web Services API be used? |
Username and password (stored in Mosaic) | Yes. |
Username and password (via LDAP) | Yes. |
Username and password (via Active Directory) | Yes. |
Single sign-on with SAML | No. |
Single sign-on with OIDC | No. |
What this means for your integrations
If you rely on the SOAP Web Services API to connect other systems to Mosaic, your environment needs to keep signing in with a username and password.
⚠️ Important: If you're planning to move to single sign-on with SAML or OIDC, the SOAP Web Services API will no longer be available after the switch. Review any integrations that depend on it before making the change, and contact us if you need guidance on alternatives.