REST API for Oracle Commerce Cloud

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

Root Schema : sendPasswordReset_request

Type: object

Show Source

confirmPassword: string

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

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

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

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

Token to validate or use in the password reset process.

{
    "properties":{
        "op":{
            "description":"One of two values: validateToken or confirmPasswordReset.",
            "type":"string"
        },
        "password":{
            "description":"New password value.  Required when resetting the password.",
            "type":"string"
        },
        "confirmPassword":{
            "description":"Confirmation value of the password.  Required when resetting the password.",
            "type":"string"
        },
        "email":{
            "description":"Email address for user profile.  Required when resetting the password.",
            "type":"string"
        },
        "token":{
            "description":"Token to validate or use in the password reset process.",
            "type":"string"
        }
    },
    "example":{
        "op":"confirmPasswordReset",
        "password":"ANewPassword123",
        "confirmPassword":"ANewPassword123",
        "email":"amber@example.com",
        "token":"sampleToken123123123"
    }
}

Example:

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

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : sendPasswordReset_response

Type: object

Show Source

success: boolean

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

{
    "properties":{
        "success":{
            "description":"True if the password was reset successfully, false if not.",
            "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| |------------------|------------------| |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.|

Root Schema : errorModel

Type: object

Show Source

devMessage: string

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

The numerical code identifying the error
errors: array errors

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

The localized message describing the error
moreInfo: string

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

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

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

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

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

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

An optional machine readable description of where the error occurred
status: 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"
        }
    }
}