Message: PasswordChangeRoutineClient

File: WebAPI/user_session_2.proto

Description

Message for multi-step password change which user should use in the case if it is required to use encoded password. Multi-step password change sequence has the following steps:

1.  Client initiates password change procedure by sending PasswordChangeRoutineClient.init_password_change to the server.

2.  The server sends one or more PasswordChangeRoutineServer.password_request messages (this step may repeat after step #3).

3.  Client sends list of PasswordChangeRoutineClient.password_response back to the server.

4.  The server sends PasswordChangeRoutineServer.password_change_result as the final message of the negotiation with the results.

Client may stop negotiation by sending PasswordChangeRoutineClient.abort_password_change message in response to any server PasswordChangeRoutineServer.password_request message.

Prerequisites: client must be logged in or receive LogonResult.result_code = RESULT_CODE_PASSWORD_EXPIRED.

Note: Only one of the fields must be specified.

Response: PasswordChangeRoutineServer.

Used in

ClientMsg

Fields

init_password_change

Type: bool

Description: True means user has decided to initiate password changing procedure.

password_responses

Type: PasswordResponse

Description: List of passwords in response to request from server. The number of passwords in the response should be equal to the number of passwords in the request from the server.

abort_password_change

Type: AbortRoutine

Description: Aborting of multi-step password change process by client.