AuthToken

class q2_sdk.hq.db.auth_token.AuthTokenRow

Bases: RepresentationRowBase

AuthTokenID: IntElement = 'AuthTokenID'

UserID: IntElement = 'UserID'

CreateDate: StringElement = 'CreateDate'

DeletedDate: StringElement = 'DeletedDate'

Serial: StringElement = 'Serial'

FirstUse: StringElement = 'FirstUse'

class q2_sdk.hq.db.auth_token.AuthToken(logger, hq_credentials=None, ret_table_obj=None)

Bases: DbObject

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)

NAME = 'AuthToken'

REPRESENTATION_ROW_CLASS

alias of AuthTokenRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(user_id, include_deleted=False, serialize_for_cli=False)

Return type:

List[AuthTokenRow]

async create(user_id, token_serial, first_use=None, serialize_for_cli=True)

async delete(auth_token_id)