Add Connection

Creates an identity provider connection and assigns it to the domains and products named in the request, in a single call. Returns the created connection as GET /connections/{connectionId} would.

connectionType selects which provider settings are expected in connection; connection.region selects the region the connection is created in. domains must all be verified — see POST /domains/{domainId}/actions/verify. enabledProducts names the products, and the tenants of those products, the connection signs users in to; use enabledEnvironments instead for products scoped by environment.

Creation and assignment are applied together: if the connection is created but cannot be assigned, it is deleted again rather than left behind for you to find. Only OIDC, WAAD, OKTA, and GOOGLE_APPS connections can be created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The connection to create, and what it is enabled for.

A connection to create or replace, together with the domains and products it serves.

string
enum
required

Provider type, which selects the settings expected in connection.

Allowed:
connection
required

Provider settings, in the shape matching connectionType.

domains
array of strings
required
length ≥ 1

Verified domains the connection signs users in for. Every domain must already be verified for the organization.

domains*

A verified domain.

enabledProducts
array of objects
required

Products, and the tenants of those products, the connection is enabled for. Send an empty array to enable the connection for no tenant-scoped product.

enabledProducts*
enabledEnvironments
array of objects | null

Products scoped by environment rather than by tenant, if any. Omit unless a product requires it.

enabledEnvironments
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json