renewSamlCertificate
post
/ccadmin/v1/merchant/renewSamlCertificate
Renews SAML certificate.
Request
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
200 Response
The following model is returned when operation succeeds.
Root Schema : renewSamlCertificate_response
Type:
Show Source
object
-
endDate(optional):
string
End date of new SAML certificate.
-
startDate(optional):
string
Start date of new SAML certificate.
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.
Root Schema : renewSamlCertificate_errorResponse
Type:
Show Source
object
-
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
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.
Root Schema : renewSamlCertificate_errorResponse
Type:
Show Source
object
-
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
Example Response (application/json)
{
"errorCode":"51302",
"message":"Renewal of SAML certificate is not enabled."
}
500 Response
Returned if renewal of SAML certificate failed.
Root Schema : renewSamlCertificate_errorResponse
Type:
Show Source
object
-
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
Example Response (application/json)
{
"errorCode":"51301",
"message":"Failed to renew certificate."
}
503 Response
Returned if renewal of SAML certificate is available.
Root Schema : renewSamlCertificate_errorResponse
Type:
Show Source
object
-
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
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.|
Root Schema : errorModel
Type:
Show Source
object
-
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
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(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