Sign in
esper_cloud_api_SSO Connections

Edit SSO connections

Updates an existing SSO connection for a tenant, identified by connection_id. Use it to change a connection's display name, strategy, or provider configuration (SAML or OIDC settings) after it's been created.

Requires a full request body (display_name, strategy, and the strategy-specific config block); returns the updated connection, including its service provider ACS URL, entity ID, logout URL, and signing certificate link where applicable.

About SSO Connections

SSO connections let a tenant authenticate users through an external identity provider using SAML (samlp) or OIDC (oidc). Editing a connection updates the underlying provider configuration Esper uses to negotiate SSO logins for that tenant. Learn more.

Key Fields / Query Parameters

  • strategy — samlp or oidc, determines which config fields apply
  • config.sign_in_url / config.x509_certificate — required for SAML connections
  • config.issuer_url / config.client_id — required for OIDC connections

Common Use Cases

  • Rotating a SAML signing certificate or updating an OIDC client ID
  • Renaming a connection's display name

Best Practices

  • Confirm which strategy (samlp vs oidc) the connection uses before submitting config fields, since each strategy requires different config properties
put/authn2/v0/tenant/{enterprise_id}/connection/{connection_id}

Path parameters

enterprise_idstring uuid required

Enterprise ID

connection_idstring uuid required

Connection ID

Request body

display_namestring
strategy'samlp' | 'oidc'

Strategy:

  • samlp - SAML connection
  • oidc - OIDC connection

Response

Updated connection

idstring
namestring
display_namestring
strategy'samlp' | 'oidc'

Strategy:

  • samlp - SAML connection
  • oidc - OIDC connection
service_provider_acs_urlstring url
service_provider_entity_idstring
service_provider_logout_urlstring
signing_certificate_linkstring
callback_urlstring url

Changes

No recorded changes to this endpoint across all 2 revisions of this API.