Skip to content

UserPortalPasscodeRulesGetRequest

Bases: OCIRequest

Requests the effective passcode rules setting for a user. The response is either UserPortalPasscodeRulesGetResponse or ErrorResponse.

Attributes:

user_id (Optional[str]):

service_provider_id (Optional[str]):

group_id (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPortalPasscodeRulesGetRequest(OCIRequest):
    """Requests the effective passcode rules setting for a user.
        The response is either UserPortalPasscodeRulesGetResponse or ErrorResponse.

    Attributes:

        user_id (Optional[str]):

        service_provider_id (Optional[str]):

        group_id (Optional[str]):

    """

    user_id: Optional[str] = field(default=None, metadata={"alias": "userId"})

    service_provider_id: Optional[str] = field(
        default=None, metadata={"alias": "serviceProviderId"}
    )

    group_id: Optional[str] = field(default=None, metadata={"alias": "groupId"})

Responses

Bases: OCIDataResponse

Response to UserPortalPasscodeRulesGetRequest.

Attributes:

disallow_repeated_digits (bool):

number_of_repeated_digits (int):

disallow_repeated_patterns (bool):

disallow_contiguous_sequences (bool):

number_of_ascending_digits (int):

number_of_descending_digits (int):

disallow_user_number (bool):

disallow_reversed_user_number (bool):

disallow_old_passcode (bool):

number_of_previous_passcodes (int):

disallow_reversed_old_passcode (bool):

min_code_length (int):

max_code_length (int):

disable_login_after_max_failed_login_attempts (bool):

max_failed_login_attempts (Optional[int]):

expire_password (bool):

passcode_expires_days (Optional[int]):

send_login_disabled_notify_email (bool):

login_disabled_notify_email_address (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPortalPasscodeRulesGetResponse(OCIDataResponse):
    """Response to UserPortalPasscodeRulesGetRequest.

    Attributes:

        disallow_repeated_digits (bool):

        number_of_repeated_digits (int):

        disallow_repeated_patterns (bool):

        disallow_contiguous_sequences (bool):

        number_of_ascending_digits (int):

        number_of_descending_digits (int):

        disallow_user_number (bool):

        disallow_reversed_user_number (bool):

        disallow_old_passcode (bool):

        number_of_previous_passcodes (int):

        disallow_reversed_old_passcode (bool):

        min_code_length (int):

        max_code_length (int):

        disable_login_after_max_failed_login_attempts (bool):

        max_failed_login_attempts (Optional[int]):

        expire_password (bool):

        passcode_expires_days (Optional[int]):

        send_login_disabled_notify_email (bool):

        login_disabled_notify_email_address (Optional[str]):

    """

    disallow_repeated_digits: bool = field(metadata={"alias": "disallowRepeatedDigits"})

    number_of_repeated_digits: int = field(metadata={"alias": "numberOfRepeatedDigits"})

    disallow_repeated_patterns: bool = field(
        metadata={"alias": "disallowRepeatedPatterns"}
    )

    disallow_contiguous_sequences: bool = field(
        metadata={"alias": "disallowContiguousSequences"}
    )

    number_of_ascending_digits: int = field(
        metadata={"alias": "numberOfAscendingDigits"}
    )

    number_of_descending_digits: int = field(
        metadata={"alias": "numberOfDescendingDigits"}
    )

    disallow_user_number: bool = field(metadata={"alias": "disallowUserNumber"})

    disallow_reversed_user_number: bool = field(
        metadata={"alias": "disallowReversedUserNumber"}
    )

    disallow_old_passcode: bool = field(metadata={"alias": "disallowOldPasscode"})

    number_of_previous_passcodes: int = field(
        metadata={"alias": "numberOfPreviousPasscodes"}
    )

    disallow_reversed_old_passcode: bool = field(
        metadata={"alias": "disallowReversedOldPasscode"}
    )

    min_code_length: int = field(metadata={"alias": "minCodeLength"})

    max_code_length: int = field(metadata={"alias": "maxCodeLength"})

    disable_login_after_max_failed_login_attempts: bool = field(
        metadata={"alias": "disableLoginAfterMaxFailedLoginAttempts"}
    )

    max_failed_login_attempts: Optional[int] = field(
        default=None, metadata={"alias": "maxFailedLoginAttempts"}
    )

    expire_password: bool = field(metadata={"alias": "expirePassword"})

    passcode_expires_days: Optional[int] = field(
        default=None, metadata={"alias": "passcodeExpiresDays"}
    )

    send_login_disabled_notify_email: bool = field(
        metadata={"alias": "sendLoginDisabledNotifyEmail"}
    )

    login_disabled_notify_email_address: Optional[str] = field(
        default=None, metadata={"alias": "loginDisabledNotifyEmailAddress"}
    )

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserPortalPasscodeRulesGetRequest

client = Client()

command = UserPortalPasscodeRulesGetRequest(
    user_id=...,
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPortalPasscodeRulesGetRequest",
    user_id=...,
    service_provider_id=...,
    group_id=...,
)

print(response)