Skip to main content

Get the default SSO settings

GET /api/2.0/settings/ssov2/default

Returns the default portal SSO settings.

Returns​

Default SSO settings. A request that is not authenticated returns 401.

EnableSso​

type: boolean

Example: true

IdpSettings​

type: SsoIdpSettings

IdpCertificates​

type: SsoCertificate[]

IdpCertificateAdvanced​

type: SsoIdpCertificateAdvanced

SpLoginLabel​

type: string

Example: "SpLoginLabel"

SpCertificates​

type: SsoCertificate[]

SpCertificateAdvanced​

type: SsoSpCertificateAdvanced

FieldMapping​

type: SsoFieldMapping

HideAuthPage​

type: boolean

Example: true

Response example​

{
  "EnableSso": true,
  "IdpSettings": {
    "EntityId": "EntityId",
    "SsoUrl": "SsoUrl",
    "SsoBinding": "SsoBinding",
    "SloUrl": "SloUrl",
    "SloBinding": "SloBinding",
    "NameIdFormat": "NameIdFormat"
  },
  "IdpCertificates": [
    {
      "SelfSigned": true,
      "Crt": "Crt",
      "Key": "Key",
      "Action": "Action",
      "DomainName": "DomainName",
      "StartDate": "2019-07-26T00:00:00",
      "ExpiredDate": "2019-07-26T00:00:00"
    }
  ],
  "IdpCertificateAdvanced": {
    "VerifyAlgorithm": "VerifyAlgorithm",
    "VerifyAuthResponsesSign": true,
    "VerifyLogoutRequestsSign": true,
    "VerifyLogoutResponsesSign": true,
    "DecryptAlgorithm": "true",
    "DecryptAssertions": true
  },
  "SpLoginLabel": "SpLoginLabel",
  "SpCertificates": [
    {
      "SelfSigned": true,
      "Crt": "Crt",
      "Key": "Key",
      "Action": "Action",
      "DomainName": "DomainName",
      "StartDate": "2019-07-26T00:00:00",
      "ExpiredDate": "2019-07-26T00:00:00"
    }
  ],
  "SpCertificateAdvanced": {
    "SigningAlgorithm": "SigningAlgorithm",
    "SignAuthRequests": true,
    "SignLogoutRequests": true,
    "SignLogoutResponses": true,
    "EncryptAlgorithm": "true",
    "DecryptAlgorithm": "true",
    "EncryptAssertions": true
  },
  "FieldMapping": {
    "FirstName": "FirstName",
    "LastName": "LastName",
    "Email": "Email",
    "Title": "Title",
    "Location": "Location",
    "Phone": "Phone"
  },
  "HideAuthPage": true
}