Check Password

class q2_sdk.hq.models.external_auth.check_password.Request(raw, login_id, password, user_primary_cif, customer_primary_cif, for_password_change, is_logon, is_prelogon_session, session_id)

Bases: BaseAuthRequest

Shape that comes in from HQ when logging in.

<HQ request="CheckPassword" messageID="b77cb071-4cc2-4149-8f66-5db6f0f10ec9">
  <LoginId>2</LoginId>
  <Password Encrypted="true">tJ6HqNzIZH0iGVdmH5t6Tw==</Password>
  <UserPrimaryCIF>MDcyMTIwMTA=</UserPrimaryCIF>
  <CustomerPrimaryCIF>MDcyMTIwMTA=</CustomerPrimaryCIF>
  <forPasswordChange>False</forPasswordChange>
  <isLogon>True</isLogon>
  <IsPrelogonSession>False</IsPrelogonSession>
  <SessionId>f4cglgcihmr2w4ebtaz2hypj</SessionId>
</HQ>

class q2_sdk.hq.models.external_auth.check_password.Response(standard_auth_response_fields)

Bases: BaseAuthResponse

<Q2Bridge request="CheckPassword" messageID="messageID">
  <Status>"Success"/"Error"</Status>
  <HQErrorReturnCode>hqErrorReturnCode</HQErrorReturnCode>
  <BearerToken>{0}</BearerToken>
  <BearerExpiresMiliSeconds>{0}</BearerExpiresMiliSeconds>
  <RefreshToken>{0}</RefreshToken>
  <EndUserMessage>{0}</EndUserMessage>
  <AuthorizationStatus>{0}</AuthorizationStatus>
  <StatusDescription>{0}</StatusDescription>
</Q2Bridge>

classmethod get_success(bearer_token=None, bearer_expires_milli_seconds=None, refresh_token=None, exception_message=None, entitlements_were_changed=None)

Many optional flags can be provided to the Check Password Response

Return type:

Self

classmethod get_failure()

Returns Failure to HQ