Skip to content

Edit SSO connections
Stable

Request

Edit SSO connections

Security
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://develop-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"
  }
}