Skip to content

Update an SSO connection

PATCH /sso-connection/{id}

`config` is shallow-MERGED over the stored config, so partial updates are safe. `client_secret` replaces the stored secret; an empty string clears it. `protocol` cannot be changed. Setting `is_active: true` (or editing a live connection) re-checks that the required IdP fields are present. Turning on `enforced` immediately blocks non-IdP sign-in for that domain's users — verify the connection works first. Requires `sso:manage`. A BROWSER SESSION must additionally carry a fresh step-up reauthentication (`X-Step-Up-Token`, obtained from `/auth/step-up`); without one the call answers `428 step_up_required` and `error.details` names the action and resource to prove. An organization API token is not challenged: step-up re-proves the person behind a session, and a token has no person behind it. It is gated because a verified domain and an SSO connection are DEFERRED membership grants: they admit a principal with no actor present at the moment they fire, which is `POST /invite` with a longer fuse.

Path Parameters

idstring
required·

SSO connection id (sso_…).

Request Body

client_secretstring

Replaces the stored secret; "" clears it.

configobject

Protocol-specific IdP settings. Never contains secrets — the OIDC client secret is write-only.

allow_idp_initiatedboolean

SAML: accept unsolicited IdP-initiated responses. Rejected by default.

client_idstring

OIDC: relying-party client id.

discovery_urlstring

OIDC: discovery document URL.

idp_entity_idstring

SAML: IdP entity id.

idp_metadata_xmlstring

SAML: paste IdP metadata to populate the fields above. Accepted on write; never returned.

idp_sso_urlstring

SAML: IdP single sign-on URL.

idp_x509_certstring

SAML: IdP signing certificate (PEM).

issuerstring

OIDC: issuer URL.

sign_authn_requestsboolean

SAML: sign SP-initiated AuthnRequests.

default_role_idstring,null
enforcedboolean
is_activeboolean
is_defaultboolean
namestring

Response Body

configobject

Protocol-specific IdP settings. Never contains secrets — the OIDC client secret is write-only.

allow_idp_initiatedboolean

SAML: accept unsolicited IdP-initiated responses. Rejected by default.

client_idstring

OIDC: relying-party client id.

discovery_urlstring

OIDC: discovery document URL.

idp_entity_idstring

SAML: IdP entity id.

idp_metadata_xmlstring

SAML: paste IdP metadata to populate the fields above. Accepted on write; never returned.

idp_sso_urlstring

SAML: IdP single sign-on URL.

idp_x509_certstring

SAML: IdP signing certificate (PEM).

issuerstring

OIDC: issuer URL.

sign_authn_requestsboolean

SAML: sign SP-initiated AuthnRequests.

created_atstring · date-time
default_role_idstring,null

Role (role_…) explicitly configured for users provisioned through this connection, or null to track the default. Org Owner is refused here. Read effective_default_role_id to learn what a JIT login actually grants.

effective_default_role_idstring,null

Server-computed: the role SSO just-in-time provisioning through this connection really grants. Equals default_role_id when that is set and the role still exists; otherwise the Member system role, which is what the join falls back to both when nothing is configured and when the configured role has since been deleted. null means even that fallback is missing, so auto-provisioning through this connection is broken and the first login seats nobody.

enforcedboolean

When enforced, users on the connection's verified domains can ONLY sign in through this IdP — social login and email codes are refused for them.

has_client_secretboolean

Whether an OIDC client secret is stored. The secret itself is never returned.

idstring

SSO connection id (sso_…).

is_activeboolean

A draft may be saved incomplete, but cannot be activated until the protocol's required fields are present.

is_defaultboolean

The connection domain resolution picks when a domain has several.

namestring
organization_idstring

Owning organization (org_…).

protocolstring
Possible values:
oidcsaml
updated_atstring · date-time
urlsRecord<string, any>

The protocol URLs to hand to the IdP administrator (ACS / metadata / callback, by protocol).

curl -X PATCH 'https://api.elaichi.ai/sso-connection/<id>' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"your_name","is_active":true,"enforced":true,"is_default":true,"config":{},"client_secret":"your_client_secret"}'
const body = {
  "name": "your_name",
  "is_active": true,
  "enforced": true,
  "is_default": true,
  "config": {},
  "client_secret": "your_client_secret"
};

const response = await fetch('https://api.elaichi.ai/sso-connection/<id>', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import os
import requests

url = "https://api.elaichi.ai/sso-connection/<id>"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}
payload = {
    "name": "your_name",
    "is_active": True,
    "enforced": True,
    "is_default": True,
    "config": {},
    "client_secret": "your_client_secret"
}

response = requests.patch(url, headers=headers, json=payload)
print(response.json())