Skip to content

LoginRequest22V5

Bases: OCIRequest

Request to login to OCI. password is not required for external authentication login from a trusted host (ACL).

The following data element is only used in XS data mode and will be ignored in AS data mode:
  signedPassword, ignored in AS data mode unless the password element is not present then an error is returned.

Attributes:

user_id (str):

password (Optional[str]):

signed_password (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class LoginRequest22V5(OCIRequest):
    """Request to login to OCI.
        password is not required for external authentication login from a trusted host (ACL).

        The following data element is only used in XS data mode and will be ignored in AS data mode:
          signedPassword, ignored in AS data mode unless the password element is not present then an error is returned.

    Attributes:

        user_id (str):

        password (Optional[str]):

        signed_password (Optional[str]):

    """

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

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

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

Responses

:: mercury_ocip.commands.base_command.ErrorResponse

:: mercury_ocip.commands.base_command.SuccessResponse

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import LoginRequest22V5

client = Client()

command = LoginRequest22V5(
    user_id=...,
    password=...,
    signed_password=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("LoginRequest22V5",
    user_id=...,
    password=...,
    signed_password=...,
)

print(response)