UserPortalPasscodeGetInfoRequest

Bases: OCIRequest

Request the user's portal passcode information. The response is either a UserPortalPasscodeGetInfoResponse or an ErrorResponse.

Attributes:

user_id (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserPortalPasscodeGetInfoRequest(OCIRequest):
    """Request the user's portal passcode information.
        The response is either a UserPortalPasscodeGetInfoResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to UserPortalPasscodeGetInfoRequest.

Attributes:

is_login_disabled (bool):

expiration_days (Optional[int]):

does_not_expire (Optional[bool]):

passcode (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserPortalPasscodeGetInfoResponse(OCIDataResponse):
    """Response to UserPortalPasscodeGetInfoRequest.

    Attributes:

        is_login_disabled (bool):

        expiration_days (Optional[int]):

        does_not_expire (Optional[bool]):

        passcode (str):

    """

    is_login_disabled: bool = field(metadata={"alias": "isLoginDisabled"})

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

    does_not_expire: Optional[bool] = field(
        default=None, metadata={"alias": "doesNotExpire"}
    )

    passcode: str = field(metadata={"alias": "passcode"})

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 UserPortalPasscodeGetInfoRequest

client = Client()

command = UserPortalPasscodeGetInfoRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPortalPasscodeGetInfoRequest",
    user_id=...,
)

print(response)