Pre Logon

enum q2_sdk.hq.models.external_auth.pre_logon.FailureReason(value)[source]

Bases: Enum

Valid values are as follows:

LockLogin = <FailureReason.LockLogin: 'LockLogin'>

DisableLogin = <FailureReason.DisableLogin: 'DisableLogin'>

LockUser = <FailureReason.LockUser: 'LockUser'>

class q2_sdk.hq.models.external_auth.pre_logon.Request(raw, login_id, user_primary_cif, customer_primary_cif, is_logon, is_prelogon_session, session_id)[source]

Bases: BaseAuthRequest

Shape that comes in from HQ after typing in a username and navigating away from the input box on login (onBlur).

<HQ request="PreLogon" messageID="{0}">
  <LoginId>2</LoginId>
  <UserPrimaryCIF>MDcyMTIwMTA=</UserPrimaryCIF>
  <CustomerPrimaryCIF>MDcyMTIwMTA=</CustomerPrimaryCIF>
  <isLogon>True</isLogon>
  <IsPrelogonSession>False</IsPrelogonSession>
  <SessionId>shb3cnukdl32c54nodvyxcsj</SessionId>
</HQ>

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

Bases: BaseAuthResponse

<Q2Bridge request="PreLogon" messageID="messageID">
  <Status>"Success"/"Error"</Status>
  <AuthorizationStatus></AuthorizationStatus>
  <EndUserMessage>{0}</EndUserMessage>
  <StatusDescription>{0}</StatusDescription>
</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