Mfa

class q2_sdk.hq.db.mfa.MfaProviderRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

MFAProviderID: int
ShortName: str
RegistrationRequired: bool
WedgeAddressID: int
TokenLifetimeInMinutes: int
class q2_sdk.hq.db.mfa.MfaRegistrationRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

MFARegistrationID: int
MFAProviderID: int
UserID: int
RegistrationValue: str
CreateDate: str
UpdatedDate: str
DeletedDate: str
class q2_sdk.hq.db.mfa.MfaGroupProfileRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

MFAGroupProfileID: int
Description: str
AuthProviderID: int
AuthProviderShortName: str
TranAuthProviderID: int
TranAuthProviderShortName: str
EDVPatrolProviderID: int
EDVPatrolProviderShortName: str
class q2_sdk.hq.db.mfa.GroupToMfaGroupProfileRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

MFAGroupProfileID: int
ProfileDescription: str
GroupID: int
class q2_sdk.hq.db.mfa.Mfa(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 = 'Mfa'
add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

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

List[GroupToMfaGroupProfileRow]

async get_group_to_mfa_group_profile_for_profile(profile_id, serialize_for_cli=False)[source]
Return type:

List[GroupToMfaGroupProfileRow]

async get_providers(serialize_for_cli=False, short_name=None)[source]
Return type:

List[MfaProviderRow]

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

List[MfaGroupProfileRow]

async get_mfa_group_profiles_for_provider(provider_name, serialize_for_cli=False)[source]
Return type:

List[MfaGroupProfileRow]

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

List[MfaRegistrationRow]

async get_registrations_for_provider(provider_name, serialize_for_cli=False)[source]
Return type:

List[MfaRegistrationRow]

async add_provider(short_name, wedge_address_short_name, registration_required, token_lifetime_in_minutes=5)[source]
Return type:

bool

async add_group_profile(description, selected_auth_provider, selected_tran_auth_provider, selected_edv_patrol_provider)[source]
async update_group_to_mfa_group_profile()[source]
async add_group_to_mfa_group_profile(selected_mfa_group_profile, selected_groups)[source]
async remove_group_to_mfa_group_profile(mfa_group_profile_id, removed_groups)[source]
async remove_provider(short_name)[source]
async remove_group_profile(mfa_group_profile_id)[source]