Skip to main content
PATCH
Update 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.

Path Parameters

connectionId
string
required

Body

application/json
displayName
string
Maximum string length: 100
enabled
boolean
metadataUrl
string<uri>
metadataXml
string
issuer
string<uri>
clientId
string
clientSecret
string

Response

The connection

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>