API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Sso Connections

AdminUpdated Sep 11, 2026

Sso Connections

Backend API — secret key (Authorization: Bearer sk_…).

6 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

GET /v1/sso_connections

sso_connections:read

List enterprise SSO connections (OIDC / SAML / DiscourseConnect). Never the client secret.

POST /v1/sso_connections

sso_connections:write

✓

Create an enterprise SSO connection. The IdP client secret is write-only.

GET /v1/sso_connections/:id

sso_connections:read

Fetch one SSO connection. Another instance id is 404, never 403. Reports has_secret, never the secret.

PATCH /v1/sso_connections/:id

sso_connections:write

✓

Update an SSO connection. A secret is only re-encrypted when a new one is supplied.

DELETE /v1/sso_connections/:id

sso_connections:write

✓

Delete an SSO connection and its domain routing.

GET /v1/sso_connections/:id/saml_metadata

sso_connections:read

The SP EntityDescriptor XML to hand a SAML IdP (entityID + ACS URL). Public; carries no secret.

Was this page helpful?