updateSamlSettings
put
/ccadmin/v1/merchant/samlSettings
Update Saml Settings. Update the SAML settings.
Request
Supported Media Types
- application/json
Root Schema : updateSamlSettings_request
Type:
Show Source
object
-
enabled:
boolean
is SAML SSO enabled
-
nameIdPolicyAllowCreate:
boolean
Controls the nameIdPolicyAllowCreate field of the AuthnRequest.
-
nameIdPolicyFormat:
string
The nameIdPolicyFormat to use.
-
requireEncryptedAssertions:
boolean
If Auth Responses are required to have encrypted assertions.
-
requireSignedResponse:
boolean
If Auth Responses are required to be signed.
-
signAuthnRequest:
boolean
If AuthnRequest should be signed.
Example:
PUT /ccadminui/v1/merchant/samlSettings
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateSamlSettings_response
Type:
Show Source
object
-
certificate:
object certificate
Details of SAML certificate.
-
enabled:
boolean
is SAML SSO enabled
-
nameIdPolicyAllowCreate:
boolean
Controls the nameIdPolicyAllowCreate field of the AuthnRequest.
-
nameIdPolicyFormat:
string
The nameIdPolicyFormat to use.
-
requireEncryptedAssertions:
boolean
If Auth Responses are required to have encrypted assertions.
-
requireSignedResponse:
boolean
If Auth Responses are required to be signed.
-
signAuthnRequest:
boolean
If AuthnRequest should be signed.
-
spMetadata:
string
The base64 encoded SP Metadata.
Nested Schema : certificate
Type:
object
Details of SAML certificate.
Show Source
-
endDate:
string
End date of new SAML certificate.
-
startDate:
string
Start date of new SAML certificate.
Example Response (application/json)
{
"nameIdPolicyFormat":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"requireEncryptedAssertions":false,
"requireSignedResponse":false,
"certificate":{
"endDate":"2048-12-14T18:16:00.000Z",
"startDate":"2021-07-29T18:16:00.000Z"
},
"signAuthnRequest":true,
"spMetadata":"[Base64 encoded SP Metadata]",
"nameIdPolicyAllowCreate":true,
"enabled":true
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code