Skip to main content
POST
Create an SSO connection

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Body

application/json
type
enum<string>
required
Available options:
saml
displayName
string
required
Maximum string length: 100
metadataUrl
string<uri>
metadataXml
string

Response

The connection, pending until the first sign-in

Credentials never leave the server; config carries only the non-secret parts.

id
string
type
enum<string>
Available options:
saml,
oidc
status
string

pending until the first successful sign-in, then active; disabled when turned off.

displayName
string
cognitoProviderName
string

The identity-provider name the login page sends users to.

config
object | null
createdAt
string<date-time>
updatedAt
string<date-time>