Patch SSO

Partially update the SSO configuration of the company (pod)

patch

Updates only the fields present in the payload. Fields left out keep their currently stored value. The resulting configuration is validated as a whole, so a partial update that leaves the configuration incomplete or invalid is rejected.

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

ssoEnabledbooleanOptional

Whether SSO authentication is enabled for the pod.

Example: true

idpEntityIdstringOptional

Entity id of the identity provider.

Example: https://idp.example.com/metadata

idpSsoEndpointstringOptional

Url the user is redirected to in order to authenticate.

Example: https://idp.example.com/sso/saml

idpSigningCertificatestringOptional

PEM encoded certificate used to verify the identity provider's assertions.

Example: -----BEGIN CERTIFICATE-----MIIH/TC...p9DBiB/-----END CERTIFICATE-----

symphonyAcsUrlstringOptional

Assertion consumer service url the identity provider posts back to. Derived from the pod's base url when the configuration has not been created yet.

Example: https://yourpodURL.symphony.com/login/sso/acs

symphonyEntityIdstringOptional

Entity id Symphony identifies itself with. Derived from the pod's base url when the configuration has not been created yet.

Example: https://yourpodURL.symphony.com

forceAuthnbooleanOptional

Whether to force users to re-authenticate with the Identity Provider during SSO, even if they have an existing active session.

Responses

200

Success

application/json

formatstring · enumOptionalExample: TEXTPossible values:

messagestringOptionalExample: Success

400

Client error, see response body for further details.

application/json

401

Unauthorized: Session tokens invalid.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

patch/v1/admin/sso/configuration

PATCH /pod/v1/admin/sso/configuration HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 352

{
  "ssoEnabled": true,
  "idpEntityId": "https://idp.example.com/metadata",
  "idpSsoEndpoint": "https://idp.example.com/sso/saml",
  "idpSigningCertificate": "-----BEGIN CERTIFICATE-----MIIH/TC...p9DBiB/-----END CERTIFICATE-----",
  "symphonyAcsUrl": "https://yourpodURL.symphony.com/login/sso/acs",
  "symphonyEntityId": "https://yourpodURL.symphony.com",
  "forceAuthn": true
}

{
  "format": "TEXT",
  "message": "Success"
}