API ReferenceManagement APISAML Connections

Update SAML Connection

Updates a SAML connection.

Path parameters

idstringRequired
The ID of the SAML connection to update.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
idstringOptional
Unique identifier for this SAML connection.
organizationIdstringOptional
The organization this SAML connection belongs to.
primarybooleanOptional
Whether this is the primary SAML connection for the organization.
idpRedirectUrlstringOptional
URL to redirect to when initiating SAML flows. IDP redirect URLs are assigned by an Identity Provider, and need to be inputted into SSOReady.
idpCertificatestringOptional

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.

idpEntityIdstringOptional
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.
spEntityIdstringOptional
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.
spAcsUrlstringOptional
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

OK
samlConnectionobject or null
The updated SAML connection.