Skip to content

Edit SSO connections
Stable

Request

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
Security
esper_cloud_api_apiKey
Path
enterprise_idstring, (uuid)required

Enterprise ID

connection_idstring, (uuid)required

Connection ID

Bodyapplication/jsonrequired
display_namestring(display name)
strategyany(strategy)

Strategy:

  • samlp - SAML connection
  • oidc - OIDC connection
Enum:"samlp""oidc"
configobject(CustomConnectionConfigResponse)
cURL
curl -i -X PUT \
  'https://api.esper.io/_mock/openapi/authn2/v0/tenant/{enterprise_id}/connection/{connection_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string",
    "strategy": "samlp",
    "config": {
      "sign_in_url": "string",
      "disable_sign_out": true,
      "sign_out_url": "string",
      "x509_certificate": "string",
      "issuer_url": "string",
      "client_id": "string"
    }
  }'

Responses

Updated connection

Bodyapplication/json
idstring(id)
namestring(name)
display_namestring(display name)
strategyany(strategy)

Strategy:

  • samlp - SAML connection
  • oidc - OIDC connection
Enum:"samlp""oidc"
service_provider_acs_urlstring, (url)(service provider ACS url)
service_provider_entity_idstring(service provider entity id)
service_provider_logout_urlstring(service provider logout url)
callback_urlstring, (url)(callback url)
configobject(CustomConnectionConfigResponse)
Response
{
  "id": "string",
  "name": "string",
  "display_name": "string",
  "strategy": "samlp",
  "service_provider_acs_url": "string",
  "service_provider_entity_id": "string",
  "service_provider_logout_url": "string",
  "signing_certificate_link": "string",
  "callback_url": "string",
  "config": {
    "sign_in_url": "string",
    "disable_sign_out": true,
    "sign_out_url": "string",
    "x509_certificate": "string",
    "issuer_url": "string",
    "client_id": "string"
  }
}