REST API for Oracle Commerce Cloud December 2017

sendPasswordReset

post

/ccadmin/v1/adminProfiles/sendPasswordReset

Send Password Reset. Validate the reset token or set a user's new password. Send just the op and token to validate; send all of the values to reset the password.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : sendPasswordReset_request

Example


{
    "op":"confirmPasswordReset",
    "password":"ANewPassword123",
    "confirmPassword":"ANewPassword123",
    "email":"amber@example.com",
    "token":"sampleToken123123123"
}

Properties

confirmPassword: Type: string

Confirmation value of the password. Required when resetting the password.
email: Type: string

Email address for user profile. Required when resetting the password.
op: Type: string

One of two values: validateToken or confirmPasswordReset.
password: Type: string

New password value. Required when resetting the password.
token: Type: string

Token to validate or use in the password reset process.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : sendPasswordReset_response

Properties

success: Type: boolean

True if the password was reset successfully, false if not.

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| |------------------|------------------| |83004|User login ID is required.| |60004|Resetting this account's password is not allowed. Check the link in your email and try again.| |83039|Passwords did not match.|

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:

{
  "op": "confirmPasswordReset",
  "password": "ANewPassword123",
  "confirmPassword": "ANewPassword123",
  "email": "amber@example.com",
  "token": "sampleToken123123123"
}

Sample Response Payload returned by endpoint:

{"success": "true"}