SSO User Logon

class q2_sdk.hq.db.sso_user_logon.SsoUserLogonRow[source]

Bases: RepresentationRowBase

SSOUserLogonID: IntElement = 'SSOUserLogonID'
UserLogonID: IntElement = 'UserLogonID'
LoginName: StringElement = 'LoginName'
SSOIdentifier: StringElement = 'SSOIdentifier'
CreateDate: StringElement = 'CreateDate'
ModifiedDate: StringElement = 'ModifiedDate'
class q2_sdk.hq.db.sso_user_logon.SsoUserLogon(logger, hq_credentials=None, ret_table_obj=None)[source]

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 = 'SsoUserLogon'
REPRESENTATION_ROW_CLASS

alias of SsoUserLogonRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(sso_identifier, serialize_for_cli=False)[source]
Return type:

List[SsoUserLogonRow]

async get_by_login_name(login_name, serialize_for_cli=True)[source]
Return type:

SsoUserLogonRow

async get_list(serialize_for_cli=False)[source]
Return type:

List[SsoUserLogonRow]

async create_by_login_name(login_name, sso_identifier)[source]
async create(user_logon_id, sso_identifier, serialize_for_cli=False)[source]
Return type:

List[SsoUserLogonRow]

async update(user_logon_id, sso_identifier, serialize_for_cli=False)[source]
Return type:

List[SsoUserLogonRow]

async delete_by_login_name(login_name)[source]
async delete(user_logon_id, serialize_for_cli=False)[source]
Return type:

List[SsoUserLogonRow]