Reference / SAML SSO

Update a SAML connection.

PATCH /v1/saml/connections/{id}

Secret API key operationId: update

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

id string<uuid> required

Connection id

Request body · required

email_attribute string
email_domain string
enabled boolean
idp_certificate string required

Base64 X.509 (DER) IdP signing certificate.
idp_entity_id string required
idp_sso_url string required
name string required
name_attribute string

Responses

200 Updated

{
  "data": {
    "acs_url": "string",
    "created_at": "2026-01-15T09:30:00Z",
    "email_attribute": "string",
    "email_domain": "string",
    "enabled": false,
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "idp_entity_id": "string",
    "idp_sso_url": "string",
    "metadata_url": "string",
    "name": "string",
    "name_attribute": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

404 No such connection

Request

curl -X PATCH "http://localhost:8080/v1/saml/connections/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f" \
  -H "Content-Type: application/json" \
  -d '{
  "email_attribute": "string",
  "email_domain": "string",
  "enabled": false,
  "idp_certificate": "string",
  "idp_entity_id": "string",
  "idp_sso_url": "string",
  "name": "Okta",
  "name_attribute": "string"
}'

Try it

live request

PATCH http://localhost:8080/v1/saml/connections/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f

Path parameters

id *

Request body

application/json