Change Password

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

Bases: BaseAuthRequest

Shape that comes in from HQ from a password change request. This can be invoked in the sandbox by navigating to Settings -> Security Preferences -> Change Password

<HQ request="ChangePassword" messageID="{0}">
  <LoginId>2</LoginId>
  <Password Encrypted="true">Ns+9NPAJs+PpmIoBirrWGQ==</Password>
  <OldPassword Encrypted="true">tJ6HqNzIZH0iGVdmH5t6Tw==</OldPassword>
  <CSRLogin>CSRLoginName</CSRLogin>
  <UserPrimaryCIF>MDcyMTIwMTA=</UserPrimaryCIF>
  <CustomerPrimaryCIF>MDcyMTIwMTA=</CustomerPrimaryCIF>
  <isLogon>True</isLogon>
  <IsPrelogonSession>False</IsPrelogonSession>
  <SessionId>shb3cnukdl32c54nodvyxcsj</SessionId>
</HQ>

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

Bases: BaseAuthResponse

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

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

classmethod get_success(*args, **kwargs)

Returns OK to HQ

Return type:: Self