Message: PasswordResponse

File: WebAPI/user_session_2.proto

Description

Response to the PasswordRequest message. This is a common message used in both trader-level (LogonRoutineClient, PasswordChangeRoutineClient) and account-level (account_authorization_2.AccountLogonRoutineClient, AccountPasswordChangeRoutineClient) multi-step logon and password change sequences.

Used in

AccountLogonRoutineClient, AccountPasswordChangeRoutineClient, LogonRoutineClient, PasswordChangeRoutineClient

Fields

request_id

Type: uint32

Description: ID of corresponding password request.

encoding_type

Type: string

Description: Commonly understood string that identifies the password encoding method.

password

Type: string

Description: User’s password encoded with specified encoding method. Note: Server ignores this attribute when use_stored=true.

use_stored

Type: bool

Description: True means ignore the value supplied in password and use the server’s stored value instead. Note: Client should only send when corresponding PasswordRequest.password_is_stored=true.

store

Type: bool

Description: True means client requests server to store this password value for use in future logons, overwriting any existing stored value. False or empty means client requests server to use this password value only for this login AND to clear any existing stored value.

Note: Client should only send when corresponding PasswordRequest.can_store_password=true. Server ignores this attribute when use_stored=true.