Skip to content

ApiLogOnResponseDTOv2

stonepy.models.ApiLogOnResponseDTOv2.ApiLogOnResponseDTOv2

Bases: ResponseModel

Response to a LogOn v2 call.

session class-attribute instance-attribute 

session: str | None = Field(
    default=None, alias="Session", repr=False
)

Your session token (treat as a random string) . Session tokens are valid for a set period from the time of their creation. The period is subject to change, and may vary depending on who you logon as.

password_change_required class-attribute instance-attribute 

password_change_required: bool | None = Field(
    default=None, alias="PasswordChangeRequired"
)

Flag used to indicate whether a password change is needed.

allowed_account_operator class-attribute instance-attribute 

allowed_account_operator: bool | None = Field(
    default=None, alias="AllowedAccountOperator"
)

Flag used to indicate whether the account operator associated with this user is allowed to access the application.

status_code class-attribute instance-attribute 

status_code: int | None = Field(
    default=None, alias="StatusCode"
)

Contains the logon status code.

is2_fa_enabled class-attribute instance-attribute 

is2_fa_enabled: bool | None = Field(
    default=None, alias="Is2FAEnabled"
)

Returns a flag if Two Factor Authentication is enabled

two_fa_token class-attribute instance-attribute 

two_fa_token: str | None = Field(
    default=None, alias="TwoFAToken", repr=False
)

Two Factor Authentication token

additional2_fa_methods class-attribute instance-attribute 

additional2_fa_methods: (
    list[Api2FALogonOnResponseDTO] | None
) = Field(default=None, alias="Additional2FAMethods")

Additional Two Factor Authentication methods