About the IAM Connections API

The IAM Connections API lets you manage the authentication connections (such as Google, Facebook, SAML, and other identity providers) that users can sign in with on a Wix site.

With the IAM Connections API, you can:

• Disable an authentication connection without losing its configuration.
• Retrieve client-safe data for the connections currently enabled on a site.

Before you begin

It's important to note the following points before starting to code:

• Every site is automatically provisioned with built-in connections for Google, Facebook, and password login, in addition to any connections you create. Built-in connections behave like any other connection.
• Connections have a two-phase lifecycle: they must be created first, then explicitly enabled to become active. Disabling a connection deactivates it without deleting its configuration, so it can be re-enabled later.
• Client data endpoints return filtered information suitable for frontend applications.

Use cases

The following use cases are supported:

• Temporarily disable authentication methods
• Retrieve connection data for client applications

Terminology

• Connection: A configuration that defines how users can authenticate with a third-party identity provider (Google, Facebook, SAML, etc.).
• Enabled connection: A connection that is active and available for users to sign in with.
• Disabled connection: A connection that exists but is not currently available for user authentication.
• Connection client data: A filtered version of connection information that contains only fields safe for client-side applications.
• Identity provider: An external service (like Google or Facebook) that authenticates users and provides identity information.
• Two-phase lifecycle: The pattern where connections are first created/configured, then separately enabled for activation.