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

Specifies if SSO is enabled or not

idpSettingsobject

entityIdstring

Entity ID

ssoUrlstring

SSO URL

ssoBindingstring

SSO binding

sloUrlstring

SLO URL

sloBindingstring

SLO binding

nameIdFormatstring

Name ID format

idpCertificatesarray of object

List of IDP certificates

selfSignedboolean

Specifies if a certificate is self-signed or not

crtstring

Certificate

keystring

Key

actionstring

Action

domainNamestring

Domain name

startDatestringformat: date-time

Start date

expiredDatestringformat: date-time

Expiration date

idpCertificateAdvancedobject

verifyAlgorithmstring

Verification algorithm

verifyAuthResponsesSignboolean

Specifies if the signatures of the SAML authentication responses sent to SP will be verified or not

verifyLogoutRequestsSignboolean

Specifies if the signatures of the SAML logout requests sent to SP will be verified or not

verifyLogoutResponsesSignboolean

Specifies if the signatures of the SAML logout responses sent to SP will be verified or not

decryptAlgorithmstring

Decryption algorithm

decryptAssertionsboolean

Specifies if the assertions will be decrypted or not

spLoginLabelstring

SP login label

spCertificatesarray of object

List of SP certificates

selfSignedboolean

Specifies if a certificate is self-signed or not

crtstring

Certificate

keystring

Key

actionstring

Action

domainNamestring

Domain name

startDatestringformat: date-time

Start date

expiredDatestringformat: date-time

Expiration date

spCertificateAdvancedobject

signingAlgorithmstring

Signing algorithm

signAuthRequestsboolean

Specifies if SP will sign the SAML authentication requests sent to IdP or not

signLogoutRequestsboolean

Specifies if SP will sign the SAML logout requests sent to IdP or not

signLogoutResponsesboolean

Specifies if sign the SAML logout responses sent to IdP or not

encryptAlgorithmstring

Encryption algorithm

decryptAlgorithmstring

Decryption algorithm

encryptAssertionsboolean

Specifies if the assertions will be encrypted or not

fieldMappingobject

firstNamestring

First name

lastNamestring

Last name

emailstringformat: email

Email

titlestring

Title

locationstring

Location

phonestring

Phone

hideAuthPageboolean

Specifies if the authentication page will be hidden or not

usersTypeintegerformat: int32

Users type (RoomAdmin, User, DocSpaceAdmin)

400

Settings could not be null

401

Unauthorized