REST API for Oracle Commerce Cloud December 2017

resetPassword

post

/ccadmin/v1/profiles/resetPassword

Reset Password. This operation is used to reset the password of a customer profile. 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: Type: string

The asset language of the request

Body Parameter

Root Schema : resetPassword_request

Example


{
    "login":"a@a.com"
}

Properties

login: Type: string

Required: true

Login of the user.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : resetPassword_response

Properties

success: Type: boolean

Returns true irrespective of existence of the profile.

Example 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| |------------------|------------------| |23025|If some internal error occurs while generating password for the specified email.| |23026|If the user input is null or empty| |23027|If email field is null or missing| |23006|If invalid email address is entered.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: 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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{"login": "a@a.com"}

Sample Response Payload returned by endpoint:

{"success": true}