File: WebAPI/user_session_2.proto
Parameters of requesting password from user. This is a common message used in both trader-level (LogonRoutineServer, PasswordChangeRoutineServer) and account-level (account_authorization_2.AccountLogonRoutineServer, AccountPasswordChangeRoutineServer) multi-step logon and password change sequences.
AccountLogonRoutineServer, AccountPasswordChangeRoutineServer, LogonRoutineServer, PasswordChangeRoutineServer
Type: uint32
Description: ID of a request.
Type: uint32
Description: Type of password which the server requests from the user. This field is associated with the PasswordType enum type.
Type: string
Description: Commonly understood code that can be used to show an additional localized prompt for certain password types.
Type: string
Description: Alternate English text for clients which do not recognize user_prompt_type. This text can be displayed as-is to the user.
Note: User_prompt_type and user_prompt_type_alt are a pair (so either none or both are provided).
Type: string
Description: Text that should be displayed to the user as-is along with the localized prompt implied by user_prompt_type. If user_prompt_type_alt is used instead, this text should be displayed after it. user_prompt will only be provided if user_prompt_type and user_prompt_type_alt are provided, but it is optional even then.
Type: Encoding
Description: Set of supported encodings for this request. Client should choose the encoding with highest priority from among those it implements.
Type: bool
Description: Tells client whether server supports client-controlled, optional storage of this password value for use in future logons. If true, and the client wants the value it submits to be stored by the server (it can either prompt user to decide, or decide automatically), then the client should set corresponding PasswordResponse.store=true. Only sent during logon sequence, not during password change sequence.
Type: bool
Description: Tells client whether server currently has a stored value for this password. Can only be true if can_store_password is also true. Only sent during logon sequence, not during password change sequence.
•PASSWORD_TYPE_STATIC = 1
Currently used password.
•PASSWORD_TYPE_ONE_TIME = 2
One-time password.
•PASSWORD_TYPE_NEW_STATIC = 3
New password that user wants to use. Can be specified only in result of PasswordChangeRoutineClient.
•PASSWORD_TYPE_CUR_AND_NEW_STATIC = 4
Currently used password and new password that user wants to use. Can be specified only in result of PasswordChangeRoutineClient.
•PASSWORD_TYPE_TEXT = 5
Non-password request with question e.g., “What is your favorite pet?”.