---
title: "PATCH /v1/saml-connections/{id}"
method: PATCH
path: "/v1/saml-connections/{id}"
tags: ["SSOReadyService"]
---

# PATCH /v1/saml-connections/{id}

`PATCH /v1/saml-connections/{id}`

Updates a SAML connection.

## Path parameters

- `id` string, required

## Request body

- SAMLConnection
  - `id` string — Unique identifier for this SAML connection.
  - `organizationId` string — The organization this SAML connection belongs to.
  - `primary` boolean — Whether this is the primary SAML connection for the organization.
  - `idpRedirectUrl` string — URL to redirect to when initiating SAML flows. IDP redirect URLs are assigned by an Identity Provider, and need to be inputted into SSOReady.
  - `idpCertificate` string — Certificate to authenticate SAML assertions. This is a PEM-encoded X.509 certificate. IDP certificates are assigned by an Identity Provider, and need to be inputted into SSOReady.
  - `idpEntityId` string — Identifier for the identity provider when handling SAML operations. IDP entity IDs are assigned by an Identity Provider, and need to be inputted into SSOReady.
  - `spEntityId` string — Identifier for the SAML connection when handling SAML operations. SP entity IDs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.
  - `spAcsUrl` string — URL the Identity Provider redirects to when transmitting SAML assertions. Stands for "Service Provider Assertion Consumer Service" URL. SP ACS URLs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.

## Response `200`

OK

- UpdateSAMLConnectionResponse
  - `samlConnection` SAMLConnection
    - `id` string — Unique identifier for this SAML connection.
    - `organizationId` string — The organization this SAML connection belongs to.
    - `primary` boolean — Whether this is the primary SAML connection for the organization.
    - `idpRedirectUrl` string — URL to redirect to when initiating SAML flows. IDP redirect URLs are assigned by an Identity Provider, and need to be inputted into SSOReady.
    - `idpCertificate` string — Certificate to authenticate SAML assertions. This is a PEM-encoded X.509 certificate. IDP certificates are assigned by an Identity Provider, and need to be inputted into SSOReady.
    - `idpEntityId` string — Identifier for the identity provider when handling SAML operations. IDP entity IDs are assigned by an Identity Provider, and need to be inputted into SSOReady.
    - `spEntityId` string — Identifier for the SAML connection when handling SAML operations. SP entity IDs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.
    - `spAcsUrl` string — URL the Identity Provider redirects to when transmitting SAML assertions. Stands for "Service Provider Assertion Consumer Service" URL. SP ACS URLs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.

## Other responses

- `default` — Default error response

## Changes

- **2024-08-17** `9a895b843207` — 1 breaking, 8 warning, 1 info
  - the `samlConnection` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `samlConnection/id` from the response with the `200` status
  - removed the optional property `samlConnection/idpCertificate` from the response with the `200` status
  - removed the optional property `samlConnection/idpEntityId` from the response with the `200` status
  - …6 more
- **2024-08-16** `132245ed6de0` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/changes/v1/saml-connections/:id/patch.md)

---

[API](https://skmtc.dev/ssoready/apis/ssoreadyservice-api.md) · [All operations](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ssoready/ssoreadyservice-api/revisions/0827d713f08e/schema)