Docmost Octri Preview
POST/sso/update

Update an SSO provider

Updates an existing SSO provider's configuration. Supply providerId and include only the fields you want to change; omitted configuration fields remain unchanged.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

18 body fields

SSO provider configuration to update. providerId is required; all other fields are optional.

allowSignupbooleanoptional
Allow or disallow automatic user creation.
groupSyncbooleanoptional
Enable or disable group sync.
isEnabledbooleanoptional
Enable or disable this provider.
ldapBaseDnstringoptional
LDAP: Updated base DN.
ldapBindDnstringoptional
LDAP: Updated bind DN.
ldapBindPasswordstringoptional
LDAP: Updated bind password.
ldapTlsCaCertstringoptional
LDAP: Updated CA certificate.
ldapTlsEnabledbooleanoptional
LDAP: Enable or disable TLS.
ldapUrlstringoptional
LDAP: Updated server URL.
ldapUserAttributesobjectoptional
LDAP: Updated attribute mapping.
ldapUserSearchFilterstringoptional
LDAP: Updated search filter.
namestringoptional
New display name.
oidcClientIdstringoptional
OIDC: Updated client ID.
oidcClientSecretstringoptional
OIDC: Updated client secret.
oidcIssuerstringoptional
OIDC: Updated issuer URL.
providerIdstringrequired
ID of the SSO provider to update.
samlCertificatestringoptional
SAML: Updated X.509 certificate (PEM format).
samlUrlstringoptional
SAML: Updated IdP metadata URL.

3 status codes
200Returns the updated SSO provider in the response payload.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when you do not have permission to update an SSO provider.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the specified SSO provider does not exist.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when you do not have permission to manage SSO providers. A 404 is returned when providerId does not identify an existing provider. providerId is required, name must not exceed 64 characters, and oidcIssuer must be a URI when provided.