LogoutRequest

Bases: OCIRequest

LogoutRequest is sent when an OCI user logs out or when connection is lost. This command can be sent either to the server, or to the client from OCS. Response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

reason (Optional[str]):

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

@dataclass(kw_only=True)
class LogoutRequest(OCIRequest):
    """LogoutRequest is sent when an OCI user logs out or when connection is lost.
        This command can be sent either to the server, or to the client from OCS.
        Response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        reason (Optional[str]):

    """

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

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

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 LogoutRequest

client = Client()

command = LogoutRequest(
    user_id=...,
    reason=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("LogoutRequest",
    user_id=...,
    reason=...,
)

print(response)