Jump to

• Request
• Response

updateSamlSettings

put

/ccadmin/v1/merchant/samlSettings

Update Saml Settings. Update the SAML settings.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateSamlSettings_request

Type: object

Show Source

• enabled(optional): boolean
  is SAML SSO enabled
• nameIdPolicyAllowCreate(optional): boolean
  Controls the nameIdPolicyAllowCreate field of the AuthnRequest.
• nameIdPolicyFormat(optional): string
  The nameIdPolicyFormat to use.
• requireEncryptedAssertions(optional): boolean
  If Auth Responses are required to have encrypted assertions.
• requireSignedResponse(optional): boolean
  If Auth Responses are required to be signed.
• signAuthnRequest(optional): boolean
  If AuthnRequest should be signed.

{
    "properties":{
        "nameIdPolicyFormat":{
            "description":"The nameIdPolicyFormat to use.",
            "type":"string"
        },
        "requireEncryptedAssertions":{
            "description":"If Auth Responses are required to have encrypted assertions.",
            "type":"boolean"
        },
        "requireSignedResponse":{
            "description":"If Auth Responses are required to be signed.",
            "type":"boolean"
        },
        "signAuthnRequest":{
            "description":"If AuthnRequest should be signed.",
            "type":"boolean"
        },
        "nameIdPolicyAllowCreate":{
            "description":"Controls the nameIdPolicyAllowCreate field of the AuthnRequest.",
            "type":"boolean"
        },
        "enabled":{
            "description":"is SAML SSO enabled",
            "type":"boolean"
        }
    },
    "example":"PUT /ccadminui/v1/merchant/samlSettings"
}

Example:

PUT /ccadminui/v1/merchant/samlSettings

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateSamlSettings_response

Type: object

Show Source

• certificate(optional): object certificate
  Details of SAML certificate.
• enabled(optional): boolean
  is SAML SSO enabled
• nameIdPolicyAllowCreate(optional): boolean
  Controls the nameIdPolicyAllowCreate field of the AuthnRequest.
• nameIdPolicyFormat(optional): string
  The nameIdPolicyFormat to use.
• requireEncryptedAssertions(optional): boolean
  If Auth Responses are required to have encrypted assertions.
• requireSignedResponse(optional): boolean
  If Auth Responses are required to be signed.
• signAuthnRequest(optional): boolean
  If AuthnRequest should be signed.
• spMetadata(optional): string
  The base64 encoded SP Metadata.

{
    "properties":{
        "nameIdPolicyFormat":{
            "description":"The nameIdPolicyFormat to use.",
            "type":"string"
        },
        "requireEncryptedAssertions":{
            "description":"If Auth Responses are required to have encrypted assertions.",
            "type":"boolean"
        },
        "requireSignedResponse":{
            "description":"If Auth Responses are required to be signed.",
            "type":"boolean"
        },
        "certificate":{
            "description":"Details of SAML certificate.",
            "type":"object",
            "properties":{
                "endDate":{
                    "description":"End date of new SAML certificate.",
                    "type":"string"
                },
                "startDate":{
                    "description":"Start date of new SAML certificate.",
                    "type":"string"
                }
            }
        },
        "signAuthnRequest":{
            "description":"If AuthnRequest should be signed.",
            "type":"boolean"
        },
        "spMetadata":{
            "description":"The base64 encoded SP Metadata.",
            "type":"string"
        },
        "nameIdPolicyAllowCreate":{
            "description":"Controls the nameIdPolicyAllowCreate field of the AuthnRequest.",
            "type":"boolean"
        },
        "enabled":{
            "description":"is SAML SSO enabled",
            "type":"boolean"
        }
    }
}

Nested Schema : certificate

Type: object

Details of SAML certificate.

Show Source

• endDate(optional): string
  End date of new SAML certificate.
• startDate(optional): string
  Start date of new SAML certificate.

{
    "description":"Details of SAML certificate.",
    "type":"object",
    "properties":{
        "endDate":{
            "description":"End date of new SAML certificate.",
            "type":"string"
        },
        "startDate":{
            "description":"Start date of new SAML certificate.",
            "type":"string"
        }
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top