BackendService

Update SAML Connection

Update a SAML Connection.

patch/v1/saml-connections/{id}

Path parameters

idstring required

The SAML Connection ID.

Request body

idstring

The SAML Connection ID. Starts with saml_connection_....

organizationIdstring

The Organization this SAML Connection belongs to.

createTimestring date-time

When the SAML Connection was created.

updateTimestring date-time

When the SAML Connection was last updated.

primaryboolean

Whether this is the primary SAML Connection for the Organization.

spAcsUrlstring

The Service Provider Assertion Consumer Service (ACS) URL.

spEntityIdstring

The Service Provider Entity ID.

idpRedirectUrlstring

The Identity Provider Redirect URL.

idpX509Certificatestring

The Identity Provider certificate, in PEM-encoded X.509 format.

Starts with ----BEGIN CERTIFICATE----.

idpEntityIdstring

The Identity Provider Entity ID.

Response

OK

Changes

Changed in 3 of the 10 revisions of this API.5182

  • e3ac0347dfbe1101See the full diff
    • the samlConnection response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property samlConnection/createTime from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/idpEntityId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/idpRedirectUrl from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/idpX509Certificate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/organizationId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/primary from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/spAcsUrl from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/spEntityId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property samlConnection/updateTime from the response with the 200 status

      response-optional-property-removed

    • added SAMLConnection to the samlConnection response property allOf list for the response status 200

      response-property-all-of-added

    • the details/items/ response's property type/format changed from object/ to / for status 400

      response-property-type-changed

    • the details/items/ response's property type/format changed from object/ to / for status 401

      response-property-type-changed

    • the details/items/ response's property type/format changed from object/ to / for status 403

      response-property-type-changed

    • the details/items/ response's property type/format changed from object/ to / for status 404

      response-property-type-changed

    • removed the optional property details/items/description from the response with the 400 status

      response-optional-property-removed

    • removed the optional property details/items/description from the response with the 401 status

      response-optional-property-removed

    • removed the optional property details/items/description from the response with the 403 status

      response-optional-property-removed

    • removed the optional property details/items/description from the response with the 404 status

      response-optional-property-removed

    • removed the optional property details/items/docsLink from the response with the 400 status

      response-optional-property-removed

    • removed the optional property details/items/docsLink from the response with the 401 status

      response-optional-property-removed

    • removed the optional property details/items/docsLink from the response with the 403 status

      response-optional-property-removed

    • removed the optional property details/items/docsLink from the response with the 404 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added