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 header parameter called Authorization.

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

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

serializeSettingsstring

Serialized SSO settings

Examples

POST /api/2.0/settings/ssov2 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/settings/ssov2 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

SSO settings

EnableSsoboolean
IdpSettingsobject
EntityIdstring
SsoUrlstring
SsoBindingstring
SloUrlstring
SloBindingstring
NameIdFormatstring
IdpCertificatesarray of object
SelfSignedboolean
Crtstring
Keystring
Actionstring
DomainNamestring
StartDatestringformat: date-time
ExpiredDatestringformat: date-time
IdpCertificateAdvancedobject
VerifyAlgorithmstring
VerifyAuthResponsesSignboolean
VerifyLogoutRequestsSignboolean
VerifyLogoutResponsesSignboolean
DecryptAlgorithmstring
DecryptAssertionsboolean
SpLoginLabelstring
SpCertificatesarray of object
SelfSignedboolean
Crtstring
Keystring
Actionstring
DomainNamestring
StartDatestringformat: date-time
ExpiredDatestringformat: date-time
SpCertificateAdvancedobject
SigningAlgorithmstring
SignAuthRequestsboolean
SignLogoutRequestsboolean
SignLogoutResponsesboolean
EncryptAlgorithmstring
DecryptAlgorithmstring
EncryptAssertionsboolean
FieldMappingobject
FirstNamestring
LastNamestring
Emailstring
Titlestring
Locationstring
Phonestring
HideAuthPageboolean

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, 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).