Skip to main content

PUT /ssoSettings

Use this method to modify the client settings when an external SAML 2.0 identity provider is used for authentication. The identity provider must be Microsoft Active Directory Federated Services (AD FS) and must reside on a server that is connected to the management network.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/ssoSettings

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
samlEnabledOptionalBooleanIndicates whether an SAML identity provider is used for authentication. This can be one of the following values.
  • true. SAML identity provider is used.
  • false. An SAML identity provider is not used.
spMetadataAttributesOptionalObjectInformation about the SAML service provider metadata.
 entityIdRequiredStringThe service provider base URL as the unique identifier of the service provider.
 signMetadataRequiredBooleanIndicates whether the generated metadata is digitally signed. This can be one of the following values.
  • true. Metadata must be signed.
  • false. Metadata can be unsigned.
 signingAlgorithmRequiredStringThe algorithm that is used to create digital signature on the metadata object. This can be the following value:
  • sha1
 signAuthenticationRequestsRequiredBooleanIndicates whether authentication requests are signed. This can be one of the following values.
  • true. Authentication requests are signed.
  • false. Authentication requests are not signed.
 requireSignedAuthenticationResponseRequiredBooleanIndicates whether authentication responses are signed. This can be one of the following values.
  • true. Authentication responses are signed.
  • false. Authentication responses are not signed.
 requireSignedArtifactResolutionRequiredBooleanIndicates whether the signing of artifact resolution requests sent to the remote identity providers is enabled. This can be one of the following values:
  • true. Signing of artifact resolutions is enabled.
  • false. Signing of artifact resolutions is disabled.
idpMetadataOptionalStringSAML identity provider metadata that was retrieved from ADFS.
The following example modifies an external SAML 2.0 identity provider client.
{
    "samlEnabled":true,
    "spMetadataParameters":{
        "entityId":"10.243.2.124",
        "signMetadata":true,
        "signingAlgorithm":"sha1",
        "signAuthenticationRequests":true,
        "requireSignedAuthenticationResponse":true,
        "requireSignedArtifactResolution":true
    },
    "idpMetadata":"IDP metadata xml"
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
    "result": "failure",
    "messages": [{
        "explanation": "The request to change the SAML  configuration could not complete for an unknown
                        reason.",
        "id": "FQXHMSE0611J",
        "recovery": {
            "text": "Specify valid parameters on the request and try the request again. If the problem
                     persists, contact Support.",
            "URL": ""
        },
        "text": "The request to change the SAML  configuration could not be completed successfully."
    }]
}