GET /ssoSettings

Use the GET method to retrieve information about the client settings when an external SAML 2.0 identity provider is used for authentication.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/ssoSettings

Query parameters

None

Response codes

Code Description
200 OK. The request completed successfully.
409 Conflict. A descriptive error message is returned in the response body.
500 Internal server error. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
samlEnabled Boolean Indicates 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.
spMetadataAttributes Object Information about the SAML service provider metadata.
  entityId String The service provider base URL as the unique identifier of the service provider.
  signMetadata Boolean Indicates 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.
  signingAlgorithm String The algorithm that is used to create digital signature on the metadata object. This can be the following value:
  • sha1
  signAuthenticationRequests Boolean Indicates whether authentication requests are signed. This can be one of the following values.
  • true. Authentication requests are signed.
  • false. Authentication requests are not signed.
  requireSignedAuthenticationResponse Boolean Indicates whether authentication responses are signed. This can be one of the following values.
  • true. Authentication responses are signed.
  • false. Authentication responses are not signed.
  requireSignedArtifactResolution Boolean Indicates 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.
spMetadata String SAML service provider metadata that was generated by Lenovo XClarity Administrator.
idpMetadata String SAML identity provider metadata that was retrieved from ADFS.

Response example

{
    "samlEnabled":true,
    "spMetadataParameters":{
        "entityId":"10.243.2.124",
        "signMetadata":true,
        "signingAlgorithm":"sha1",
        "signAuthenticationRequests":true,
        "requireSignedAuthenticationResponse":true,
        "requireSignedArtifactResolution":true
    },
    "spMetadata":"SP metadata xml ",
    "idpMetadata":"IDP metadata xml"
}