Check Logon Status

class q2_sdk.hq.models.external_auth.check_logon_status.SuccessLogonStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]: Bases: Enum

class q2_sdk.hq.models.external_auth.check_logon_status.FailureLogonStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]: Bases: Enum

class q2_sdk.hq.models.external_auth.check_logon_status.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 before the CheckPassword step.

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

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

Bases: BaseAuthResponse

<Q2Bridge request="CheckStatus" messageID="messageID">
  <Status>"Success"/"Error"</Status>
  <Locked>true</Locked>
  <HQErrorReturnCode>{0}</HQErrorReturnCode>
  <StatusDescription>{0}</StatusDescription>
</Q2Bridge>

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

classmethod get_failure(logon_status)[source]: Failed Logon Statuses can either result in Locked or Disabled logons