Change Login

class q2_sdk.hq.models.external_auth.change_login.Request(raw, user_id, login_id, current_login_name, new_login_name, is_logon)

Bases: BaseAuthRequest

Shape that comes in from HQ when login is changed. Two ways to invoke in the sandboxes:

Ensure Customer/CanChangeLoginName UserPropertyData is set to True, then it will be available in settings -> Security Preference -> Change Login ID.

Run q2 db change_user_logon_name from the CLI.

<HQ request="ChangeLogin" messageID="{0}">
  <UserId>2</UserId>
  <LoginId>3</LoginId>
  <Login>LoginName</Login>
  <NewLogin>NewLoginName</NewLogin>
  <CSRLogin>CSRLoginName</CSRLogin>
  <isLogon>True</isLogon>
</HQ>

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

Bases: BaseAuthResponse

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

classmethod get_failure(exception_message)

Same as basic get_failure but with a customizable exception_message

classmethod get_success(*args, **kwargs)

Returns OK to HQ

Return type:

Self