changePassword

Used to change a user's password in the Luminate Online constituent database.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRConsAPI SRConsAPI POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=changePassword &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &old_password=value &user_password=value &retype_password=value &reminder_hint=value [ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=changePassword & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & old_password =value & user_password =value & retype_password =value & reminder_hint =value [ & cons_id =value ] [ & member_id =value ] [ & primary_email =value ]

Usage Notes

If called as a Client API, this method requires authentication. If the caller is an administrator (normally only the case using the Server API):
  1. One of cons_id, member_id, or primary_email must be specified in order to locate the record of the constituent whose password is to be changed.
  2. The order of precedence of the search terms is (a) cons_id (b) member_id, then (c) primary_email. If a record is not found or if multiple records are returned by any specified search term evaluated in this order, the method returns an error.
If the requester is a constituent using the Client API:
  1. An authentication token representing the logged-in user must be passed.
  2. Only the password of the logged in user may be changed.
Note: For security reasons, you cannot use this API to change an administrator's password.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

old_password

Required. The user's existing password.

Type xsd:string.

user_password

Required. The new password.

Type xsd:string.

retype_password

Required. The new password re-typed by the user to confirm.

Type xsd:string.

reminder_hint

Required. Password hint entered by the user.

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

old_password

Required. The user's existing password.

Type xsd:string.

user_password

Required. The new password.

Type xsd:string.

retype_password

Required. The new password re-typed by the user to confirm.

Type xsd:string.

reminder_hint

Required. Password hint entered by the user.

Type xsd:string.

cons_id

Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.

Type xsd:string.

member_id

Optional. The member ID (Client ID) that uniquely identifies the constituent.

Type xsd:string.

primary_email

Optional. The primary email address that uniquely identifies the constituent.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<updateConsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <cons_id>1000121</cons_id>
  <message>User updated.</message>
</updateConsResponse>

        
JSON response
{"updateConsResponse":{"message":"User updated.","cons_id":"1000121"}}

        

Leave a Comment

Nickname
Comment
Enter this word: