Jump to

• Request
• Response

renewSamlCertificate

post

/ccadmin/v1/merchant/renewSamlCertificate

Renews SAML certificate.

Request

Supported Media Types

• application/json

Body ()

Root Schema : renewSamlCertificate_request

Show Source

{
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned when operation succeeds.

Body ()

Root Schema : renewSamlCertificate_response

Type: object

Show Source

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

{
    "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)

{
    "endDate":"2048-12-14T18:16:00.000Z",
    "startDate":"2021-07-29T18:16:00.000Z"
}

202 Response

Returned if renewal is accepted but a new certificate is not loaded yet.

Body ()

Root Schema : renewSamlCertificate_errorResponse

Type: object

Show Source

• errorCode(optional): string
  The Commerce error code. See the table below for information on common codes.
• message(optional): string
  The localized message for the error.
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The Commerce error code. See the table below for information on common codes.",
            "type":"string"
        },
        "message":{
            "description":"The localized message for the error.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"51304",
    "message":"New certificate is not ready for use. Try to check later using getSamlSettings endpoint."
}

409 Response

Returned if renewal of SAML certificate is not enabled in configuration.

Body ()

Root Schema : renewSamlCertificate_errorResponse

Type: object

Show Source

• errorCode(optional): string
  The Commerce error code. See the table below for information on common codes.
• message(optional): string
  The localized message for the error.
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The Commerce error code. See the table below for information on common codes.",
            "type":"string"
        },
        "message":{
            "description":"The localized message for the error.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"51302",
    "message":"Renewal of SAML certificate is not enabled."
}

500 Response

Returned if renewal of SAML certificate failed.

Body ()

Root Schema : renewSamlCertificate_errorResponse

Type: object

Show Source

• errorCode(optional): string
  The Commerce error code. See the table below for information on common codes.
• message(optional): string
  The localized message for the error.
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The Commerce error code. See the table below for information on common codes.",
            "type":"string"
        },
        "message":{
            "description":"The localized message for the error.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"51301",
    "message":"Failed to renew certificate."
}

503 Response

Returned if renewal of SAML certificate is available.

Body ()

Root Schema : renewSamlCertificate_errorResponse

Type: object

Show Source

• errorCode(optional): string
  The Commerce error code. See the table below for information on common codes.
• message(optional): string
  The localized message for the error.
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The Commerce error code. See the table below for information on common codes.",
            "type":"string"
        },
        "message":{
            "description":"The localized message for the error.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"51303",
    "message":"The certificate renewal is not available at the moment. Please try later."
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |51301|Failed to renew certificate.| |51302|Renewal of SAML certificate is not enabled.| |51303|The certificate renewal is not available at the moment. Please try later.| |51304|New certificate is not ready for use. Try to check later using getSamlSettings endpoint.|

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