AdminLogons

class q2_sdk.hq.db.admin_logons.AdminLogonsRow[source]

Bases: RepresentationRowBase

AdminUserLogonID: IntElement = 'AdminUserLogonID'
AdminUserID: IntElement = 'AdminUserID'
LoginName: StringElement = 'LoginName'
DeletedDate: StringElement = 'DeletedDate'
class q2_sdk.hq.db.admin_logons.AdminLogons(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: DbObject

Note: This database object should only be used to support integrations that rely on it. If that is not the case, use the AdminUserLogon DBObject instead.

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

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

  • hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)

  • ret_table_obj (Optional[bool]) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

GET_BY_NAME_KEY = 'LoginName'
NAME = 'AdminLogons'
REPRESENTATION_ROW_CLASS

alias of AdminLogonsRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(login_name=None, include_deleted=False, serialize_for_cli=False)[source]
Return type:

List[AdminLogonsRow]