ExternalAuth

class q2_sdk.hq.db.external_auth.ExternalAuthenticationConfigRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

ExternalAuthenticationConfigID: int

ShortName: str

Enabled: bool

class q2_sdk.hq.db.external_auth.Action(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Enable = 'enable'

Disable = 'disable'

class q2_sdk.hq.db.external_auth.ExternalAuth(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 = 'ExternalAuth'

add_arguments(parser)[source]: Hook for subclassed DbObjects to add custom arguments.

async get_configs(serialize_for_cli=False)[source]

Return type:: List[ExternalAuthenticationConfigRow]

async set_config(short_name, enabled, serialize_for_cli=False)[source]