LogonAdmin module

LogonAdmin

class q2_sdk.hq.hq_api.backoffice.LogonAdmin.ParamsObj(logger, hq_credentials, client_address, login_name, user_password, client_session_id=None)[source]

Bases: BackOfficeParamsObj

Parameters definition for LogonAdmin

Parameters:

  • logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)

  • client_address (str) – IP of the client (for logging)

  • client_session_id (Optional[str]) – (Optional) self.online_session.session_id

  • hq_credentials (HqCredentials) – HqCredentials instance

async q2_sdk.hq.hq_api.backoffice.LogonAdmin.execute(params_obj, **kwargs)[source]
Parameters:

params_obj (ParamsObj) – Object containing everything necessary to call this HQ endpoint

Return type:

BackOfficeResponse