UpdateUserLogon models

DataSet models for UpdateUserLogon.

These typed dataclass models represent the tables and columns within the DataSet parameters for the UpdateUserLogon 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 UpdateUserLogon

q2_user_logon = UpdateUserLogon.Q2UserLogon(
    user_id=1,
    login_name="...",
    user_password="...",
    ui_source_id=1,
    status=1,
    create_date="...",
    auto_generated=True,
    password_change_required=True,
    password_has_never_changed=True,
)

class q2_sdk.hq.hq_api.backoffice.UpdateUserLogon_models.Q2UserLogon(user_logon_id=-1, user_id=0, login_name='', user_password='', ui_source_id=0, last_change=None, last_logon=None, status=0, status_reason=None, last_failed=None, create_date='', num_invalid_attempts=None, auto_generated=False, deleted_date=None, sync_pwd_user_logon_id=None, csr_assist_policy_id=None, csr_assist_admin_user_id=None, mla_challenge_code=None, password_change_required=False, password_has_never_changed=False, num_invalid_oob_attempts=None, one_time_auth_code=None, one_time_auth_code_expiration_date=None, original_record=None)

Bases: object

Represents a row in the Q2_UserLogon table.

user_logon_id: int = -1

user_id: int = 0

login_name: str = ''

user_password: str = ''

ui_source_id: int = 0

last_change: str | None = None

last_logon: str | None = None

status: int = 0

status_reason: str | None = None

last_failed: str | None = None

create_date: str = ''

num_invalid_attempts: int | None = None

auto_generated: bool = False

deleted_date: str | None = None

sync_pwd_user_logon_id: int | None = None

csr_assist_policy_id: int | None = None

csr_assist_admin_user_id: int | None = None

mla_challenge_code: str | None = None

password_change_required: bool = False

password_has_never_changed: bool = False

num_invalid_oob_attempts: int | None = None

one_time_auth_code: str | None = None

one_time_auth_code_expiration_date: str | None = None

original_record: Q2UserLogon | None = None

static get_columns()

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

Return type:

list[list[str]]

to_row_values()

Returns column values in get_columns() order.

Return type:

list[Any]

classmethod from_hq_response(row_elem)

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

Return type:

Q2UserLogon

q2_sdk.hq.hq_api.backoffice.UpdateUserLogon_models.build_dal_user_logon_dataset(q2_user_logon=None)

Build the dal_user_logon DataSet parameter for UpdateUserLogon.

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 ‘dal_user_logon’ parameter