SetPasswordPolicy models

DataSet models for SetPasswordPolicy.

These typed dataclass models represent the tables and columns within the DataSet parameters for the SetPasswordPolicy HQ operation.

IMPORTANT: Update operations require a GET first to populate the original_record field. HQ uses the unchanged row for optimistic concurrency checking.

Usage:

from q2_sdk.hq.hq_api.backoffice import SetPasswordPolicy

q2_password_policy_by_ui_source_id = SetPasswordPolicy.Q2PasswordPolicyByUISourceId(
    ui_source_id=1,
    password_policy_id=1,
    password_history_number=1,
    max_password_age=1,
    min_password_age=1,
    max_password_length=1,
    min_password_length=1,
    numbers_required=1,
    upper_case_required=1,
    lower_case_required=1,
    special_char_required=1,
    invalid_attempts=1,
    invalid_action=1,
    limit_repeating=1,
    limit_adjacent=1,
    exclude_char_list="...",
    auto_reset_hours=1,
    new_pwd_expiration_hours=1,
    cqr_count=1,
    cqr_invalid_attempts=1,
    case_sensitive_answer=1,
    question_min_length=1,
    answer_min_length=1,
    tac_required_lost_pwd=1,
    tacttl_minutes=1,
    tac_delivery_via_voice=1,
    tac_delivery_via_email=1,
    tac_length=1,
    description="...",
    login_min_length=1,
    login_max_length=1,
    dormant_days=1,
    mla_min_length=1,
    mla_max_length=1,
    mla_require_alpha=True,
    mla_require_numeric=True,
    tac_delivery_via_sms=True,
    oob_invalid_attempts=1,
    oob_invalid_action=1,
    exclude_login_char_list="...",
    login_numeric_required=True,
    login_alpha_required=True,
    login_special_char_required=True,
)

class q2_sdk.hq.hq_api.backoffice.SetPasswordPolicy_models.Q2PasswordPolicyByUISourceId(ui_source_id=0, password_policy_id=0, password_history_number=0, max_password_age=0, min_password_age=0, max_password_length=0, min_password_length=0, numbers_required=0, upper_case_required=0, lower_case_required=0, special_char_required=0, invalid_attempts=0, invalid_action=0, limit_repeating=0, limit_adjacent=0, exclude_char_list='', auto_reset_hours=0, new_pwd_expiration_hours=0, cqr_count=0, cqr_invalid_attempts=0, case_sensitive_answer=0, question_min_length=0, answer_min_length=0, tac_required_lost_pwd=0, tacttl_minutes=0, tac_delivery_via_voice=0, tac_delivery_via_email=0, tac_length=0, description='', login_min_length=0, login_max_length=0, dormant_days=0, mla_min_length=0, mla_max_length=0, mla_require_alpha=False, mla_require_numeric=False, tac_delivery_via_sms=False, oob_invalid_attempts=0, oob_invalid_action=0, exclude_login_char_list='', login_numeric_required=False, login_alpha_required=False, login_special_char_required=False, original_record=None)[source]

Bases: object

Represents a row in the Q2_PasswordPolicyByUISourceId table.

ui_source_id: int = 0

password_policy_id: int = 0

password_history_number: int = 0

max_password_age: int = 0

min_password_age: int = 0

max_password_length: int = 0

min_password_length: int = 0

numbers_required: int = 0

upper_case_required: int = 0

lower_case_required: int = 0

special_char_required: int = 0

invalid_attempts: int = 0

invalid_action: int = 0

limit_repeating: int = 0

limit_adjacent: int = 0

exclude_char_list: str = ''

auto_reset_hours: int = 0

new_pwd_expiration_hours: int = 0

cqr_count: int = 0

cqr_invalid_attempts: int = 0

case_sensitive_answer: int = 0

question_min_length: int = 0

answer_min_length: int = 0

tac_required_lost_pwd: int = 0

tacttl_minutes: int = 0

tac_delivery_via_voice: int = 0

tac_delivery_via_email: int = 0

tac_length: int = 0

description: str = ''

login_min_length: int = 0

login_max_length: int = 0

dormant_days: int = 0

mla_min_length: int = 0

mla_max_length: int = 0

mla_require_alpha: bool = False

mla_require_numeric: bool = False

tac_delivery_via_sms: bool = False

oob_invalid_attempts: int = 0

oob_invalid_action: int = 0

exclude_login_char_list: str = ''

login_numeric_required: bool = False

login_alpha_required: bool = False

login_special_char_required: bool = False

original_record: Q2PasswordPolicyByUISourceId | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PasswordPolicyByUISourceId

q2_sdk.hq.hq_api.backoffice.SetPasswordPolicy_models.build_password_policy_dataset(q2_password_policy_by_ui_source_id=None)[source]

Build the password_policy DataSet parameter for SetPasswordPolicy.

For update operations, each model instance should have its original_record set to the pre-modification state (from a prior GET call).

For add operations, set auto-increment ID fields to negative values.

Return type:: DataSetBuilder
Returns:: DataSetBuilder ready to pass as the ‘password_policy’ parameter