Jump to

• Request
• Response

updateExpiredPassword

post

/ccstore/v1/profiles/updateExpiredPassword

Update Expired Password. Used to change password of the profile,if current password is expired. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

• application/json

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Body ()

Root Schema : updateExpiredPassword_request

Type: object

Show Source

• confirmPassword(optional): string
  Confirmation of the new password. This should match the new password value. This will be optional when the operation is validateToken.
• login(optional): string
  Login of the user. This will be optional when the operation is validateToken.
• op(optional): string
  The operation to be performed. This is an optional parameter that can be set to validateToken to just validate the token.
• password(optional): string
  The new password. This will be optional when the operation is validateToken.
• token: string
  The token for the password reset.

{
    "properties":{
        "op":{
            "description":"The operation to be performed. This is an optional parameter that can be set to validateToken to just validate the token.",
            "type":"string"
        },
        "password":{
            "description":"The new password. This will be optional when the operation is validateToken.",
            "type":"string"
        },
        "confirmPassword":{
            "description":"Confirmation of the new password. This should match the new password value. This will be optional when the operation is validateToken.",
            "type":"string"
        },
        "login":{
            "description":"Login of the user. This will be optional when the operation is validateToken.",
            "type":"string"
        },
        "token":{
            "description":"The token for the password reset.",
            "type":"string"
        }
    },
    "required":[
        "token"
    ],
    "example":{
        "newPassword":"12345678",
        "login":"[e-mail]",
        "newConfirmPassword":"12345678",
        "token":"yJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMTAwMzMiLCJpc3MiOiJzdG9yZWZyb250VUkiLCJleHAiOjE1MDQxMTE3OTQsImlhdCI6MTUwNDA5MDE5NH0=.+AllN7uBoKLc98HDY4nqlqq9IdB575B62tfzclBmewM="
    }
}

Example:

{
    "newPassword":"12345678",
    "login":"[e-mail]",
    "newConfirmPassword":"12345678",
    "token":"yJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMTAwMzMiLCJpc3MiOiJzdG9yZWZyb250VUkiLCJleHAiOjE1MDQxMTE3OTQsImlhdCI6MTUwNDA5MDE5NH0=.+AllN7uBoKLc98HDY4nqlqq9IdB575B62tfzclBmewM="
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateExpiredPassword_response

Type: object

Show Source

• success(optional): boolean
  Returns true if the password is updated successfully.

{
    "properties":{
        "success":{
            "description":"Returns true if the password is updated successfully.",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "success":true
}

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| |------------------|------------------| |83037|If the token authentication fails.| |23026|If the user input is null or empty.| |83039|If the password and the confirm password do not match.| |83032|If there is an error while updating the password.|

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