Save the SSO settings

POST /api/2.0/settings/ssov2

Request

Saves the SSO settings for the current portal.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

SSO settings request parameters

serializeSettingsstring

Serialized SSO settings

Examples

POST /api/2.0/settings/ssov2 HTTP/1.1
Accept: application/json
Content-Length: 38
Content-Type: application/json
Host: example.com

{
  "serializeSettings": "some text"
}
curl --request POST \
  --url https://example.com/api/2.0/settings/ssov2 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "serializeSettings": "some text"
}'

Responses

200

SSO settings

enableSsoboolean
idpSettingsobject
entityIdstring
ssoUrlstring
ssoBindingstring
sloUrlstring
sloBindingstring
nameIdFormatstring
idpCertificatesarray of unknown
idpCertificateAdvancedobject
verifyAlgorithmstring
verifyAuthResponsesSignboolean
verifyLogoutRequestsSignboolean
verifyLogoutResponsesSignboolean
decryptAlgorithmstring
decryptAssertionsboolean
spLoginLabelstring
spCertificatesarray of unknown
spCertificateAdvancedobject
signingAlgorithmstring
signAuthRequestsboolean
signLogoutRequestsboolean
signLogoutResponsesboolean
encryptAlgorithmstring
decryptAlgorithmstring
encryptAssertionsboolean
fieldMappingobject
firstNamestring
lastNamestring
emailstringformat: email
titlestring
locationstring
phonestring
hideAuthPageboolean

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).