Mfa

class q2_sdk.hq.db.mfa.MfaProviderRow

Bases: RepresentationRowBase

MFAProviderID: IntElement = 'MFAProviderID'

ShortName: StringElement = 'ShortName'

RegistrationRequired: BoolElement = 'RegistrationRequired'

WedgeAddressID: IntElement = 'WedgeAddressID'

TokenLifetimeInMinutes: IntElement = 'TokenLifetimeInMinutes'

class q2_sdk.hq.db.mfa.MfaRegistrationRow

Bases: RepresentationRowBase

MFARegistrationID: IntElement = 'MFARegistrationID'

MFAProviderID: IntElement = 'MFAProviderID'

UserID: IntElement = 'UserID'

RegistrationValue: StringElement = 'RegistrationValue'

CreateDate: StringElement = 'CreateDate'

UpdatedDate: StringElement = 'UpdatedDate'

DeletedDate: StringElement = 'DeletedDate'

class q2_sdk.hq.db.mfa.MfaGroupProfileRow

Bases: RepresentationRowBase

MFAGroupProfileID: IntElement = 'MFAGroupProfileID'

Description: StringElement = 'Description'

AuthProviderID: IntElement = 'AuthProviderID'

AuthProviderShortName: StringElement = 'AuthProviderShortName'

TranAuthProviderID: IntElement = 'TranAuthProviderID'

TranAuthProviderShortName: StringElement = 'TranAuthProviderShortName'

EDVPatrolProviderID: IntElement = 'EDVPatrolProviderID'

EDVPatrolProviderShortName: StringElement = 'EDVPatrolProviderShortName'

class q2_sdk.hq.db.mfa.GroupToMfaGroupProfileRow

Bases: RepresentationRowBase

MFAGroupProfileID: IntElement = 'GroupToMfaGroupProfileID'

ProfileDescription: StringElement = 'ProfileDescription'

GroupID: IntElement = 'GroupID'

class q2_sdk.hq.db.mfa.Mfa(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 = 'Mfa'

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get_group_to_mfa_group_profile(serialize_for_cli=False)

Return type:

List[GroupToMfaGroupProfileRow]

async get_group_to_mfa_group_profile_for_profile(profile_id, serialize_for_cli=False)

Return type:

List[GroupToMfaGroupProfileRow]

async get_providers(serialize_for_cli=False, short_name=None)

Return type:

List[MfaProviderRow]

async get_mfa_group_profiles(serialize_for_cli=False)

Return type:

List[MfaGroupProfileRow]

async get_mfa_group_profiles_for_provider(provider_name, serialize_for_cli=False)

Return type:

List[MfaGroupProfileRow]

async get_registrations(serialize_for_cli=False)

Return type:

List[MfaRegistrationRow]

async get_registrations_for_provider(provider_name, serialize_for_cli=False)

Return type:

List[MfaRegistrationRow]

async add_provider(short_name, wedge_address_short_name, registration_required, token_lifetime_in_minutes=5)

Return type:

bool

async add_group_profile(description, selected_auth_provider, selected_tran_auth_provider, selected_edv_patrol_provider)

async update_group_to_mfa_group_profile()

async add_group_to_mfa_group_profile(selected_mfa_group_profile, selected_groups)

async remove_group_to_mfa_group_profile(mfa_group_profile_id, removed_groups)

async remove_provider(short_name)

async remove_group_profile(mfa_group_profile_id)