Get Started
Usage API
More information

GET api/2.0/settings/ssov2/default This function requires authentication

Description

Returns the default portal SSO settings.

Parameters

This method doesn't have any parameters.

Example
GET api/2.0/settings/ssov2/default
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Default SSO settings

Example Response

application/json

{
  "status": 0,
  "response": {
    "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
    },
    "FieldMapping": {
      "FirstName": "FirstName",
      "LastName": "LastName",
      "Email": "Email",
      "Title": "Title",
      "Location": "Location",
      "Phone": "Phone"
    },
    "HideAuthPage": true
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <EnableSso>True</EnableSso>
    <IdpSettings>
      <EntityId>EntityId</EntityId>
      <SsoUrl>SsoUrl</SsoUrl>
      <SsoBinding>SsoBinding</SsoBinding>
      <SloUrl>SloUrl</SloUrl>
      <SloBinding>SloBinding</SloBinding>
      <NameIdFormat>NameIdFormat</NameIdFormat>
    </IdpSettings>
    <IdpCertificates>
      <SelfSigned>True</SelfSigned>
      <Crt>Crt</Crt>
      <Key>Key</Key>
      <Action>Action</Action>
      <DomainName>DomainName</DomainName>
      <StartDate>2019-07-26T00:00:00</StartDate>
      <ExpiredDate>2019-07-26T00:00:00</ExpiredDate>
    </IdpCertificates>
    <IdpCertificateAdvanced>
      <VerifyAlgorithm>VerifyAlgorithm</VerifyAlgorithm>
      <VerifyAuthResponsesSign>True</VerifyAuthResponsesSign>
      <VerifyLogoutRequestsSign>True</VerifyLogoutRequestsSign>
      <VerifyLogoutResponsesSign>True</VerifyLogoutResponsesSign>
      <DecryptAlgorithm>True</DecryptAlgorithm>
      <DecryptAssertions>True</DecryptAssertions>
    </IdpCertificateAdvanced>
    <SpLoginLabel>SpLoginLabel</SpLoginLabel>
    <SpCertificates>
      <SelfSigned>True</SelfSigned>
      <Crt>Crt</Crt>
      <Key>Key</Key>
      <Action>Action</Action>
      <DomainName>DomainName</DomainName>
      <StartDate>2019-07-26T00:00:00</StartDate>
      <ExpiredDate>2019-07-26T00:00:00</ExpiredDate>
    </SpCertificates>
    <SpCertificateAdvanced>
      <SigningAlgorithm>SigningAlgorithm</SigningAlgorithm>
      <SignAuthRequests>True</SignAuthRequests>
      <SignLogoutRequests>True</SignLogoutRequests>
      <SignLogoutResponses>True</SignLogoutResponses>
      <EncryptAlgorithm>True</EncryptAlgorithm>
      <DecryptAlgorithm>True</DecryptAlgorithm>
    </SpCertificateAdvanced>
    <FieldMapping>
      <FirstName>FirstName</FirstName>
      <LastName>LastName</LastName>
      <Email>Email</Email>
      <Title>Title</Title>
      <Location>Location</Location>
      <Phone>Phone</Phone>
    </FieldMapping>
    <HideAuthPage>True</HideAuthPage>
  </response>
</result>