Availability

Breeze 4

Description

Changes a user’s password. A password can be changed in either of these cases:

  • By an Administrator logged in to the account, with or without the user’s old password

  • By any Adobe Connect Server user, with the user’s principal-id number, login name, and old password

An Administrator can create rules for valid passwords on the server. These rules might include, for example, the number and types of characters a password must contain. If a user submits a new password that does not adhere to the rules, Adobe Connect would throw an error showing that the new password is invalid.

When you call user-update-pwd, the password is sent over HTTP or HTTPS in hashed form.

Request URL

 http://server_name/api/xml 
     ?action=user-update-pwd 
     &user-id=integer 
     &password-old=string 
     &password=string 
     &password-verify=string 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

user-id

BIGINT

Y

The ID of the user.

password-old

String

Y/N

The user’s current password. Required for regular users, but not for Administrator users.

password

String

Y

The new password.

password-verify

String

Y

A second copy of the new password, for verification.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

 <?xml version="1.0" encoding="utf-8" ?> 
 <results> 
     <status code=allowedValue /> 
 </results>

Response values

Element

Attribute

Type

Description

results

Container

All results the action returns.

status

Empty, with attributes

The status of the response.

code

Allowed value

A code indicating the response status (see status).

Sample request

This request can be used by an Administrator to change a user’s password without knowing the old password:

 https://example.com/api/xml?action=user-update-pwd&user-id=12345&password=newone&password-verify=newone

Sample response

This response shows that the change was successful:

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
 </results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy