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 Onboarding Profiles

AdminUpdated Sep 11, 2026

Sso Onboarding Profiles

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

5 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_onboarding_profiles

sso_connections:read

List self-service SSO onboarding profiles (the templates tickets are issued from).

POST /v1/sso_onboarding_profiles

sso_connections:write

✓

Create a self-service SSO onboarding profile: allowed connection types and an optional bound organization.

GET /v1/sso_onboarding_profiles/:id

sso_connections:read

Fetch one onboarding profile. Another instance id is 404, never 403.

DELETE /v1/sso_onboarding_profiles/:id

sso_connections:write

Delete an onboarding profile; its issued tickets cascade away with it.

POST /v1/sso_onboarding_profiles/:id/tickets

sso_connections:write

✓

Issue a scoped, one-time, expiring onboarding ticket for one organization. Returns the token and hosted URL exactly once.

Was this page helpful?