Lost Password

class q2_sdk.hq.models.external_auth.lost_password.Request(raw, user_id, user_primary_cif, customer_primary_cif, is_prelogon_session, session_id)[source]

Bases: BaseAuthRequest

Shape that comes in from HQ from a password change request. On the login page, click the “Forgot Your Password?” link at the bottom.

<HQ request="LostPassword" messageID="{0}">
  <UserId>2</UserId>
  <CSRLogin>MyLoginName</CSRLogin>
  <UserPrimaryCIF>MDcyMTIwMTA=</UserPrimaryCIF>
  <CustomerPrimaryCIF>MDcyMTIwMTA=</CustomerPrimaryCIF>
  <IsPrelogonSession>False</IsPrelogonSession>
  <SessionId>shb3cnukdl32c54nodvyxcsj</SessionId>
</HQ>

class q2_sdk.hq.models.external_auth.lost_password.Response(standard_auth_response_fields)[source]

Bases: BaseAuthResponse

<Q2Bridge request="LostPassword" messageID="messageID">
  <Status>"Success"/"Error"</Status>
  <StatusDescription>{0}</StatusDescription>
  <EndUserMessage>{0}</EndUserMessage>
  <HQErrorReturnCode>{0}</HQErrorReturnCode>
  <LostPasswordFailed>{0}</LostPasswordFailed>
</Q2Bridge>

classmethod get_success()[source]: Returns OK to HQ

classmethod get_failure(failure_reason)[source]: Same as basic get_failure but can provide a reason for failure