PasswordGenerateRequest

Bases: OCIRequest

Generate passwords based on the corresponding password/passcode rules. The response is either PasswordGenerateResponse or ErrorResponse.

Attributes:

system_administrator_password (Optional[PasswordForSystemAdministrator]):

service_provider_administrator_password (Optional[PasswordForServiceProviderAdministrator]):

group_administrator_password (Optional[PasswordForGroupAdministrator]):

user_password (Optional[PasswordForUser]):

access_device_authentication_password (Optional[PasswordForAccessDevice]):

trunk_group_authentication_password (Optional[PasswordForTrunkGroup]):

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

@dataclass(kw_only=True)
class PasswordGenerateRequest(OCIRequest):
    """Generate passwords based on the corresponding password/passcode rules.
        The response is either PasswordGenerateResponse or ErrorResponse.

    Attributes:

        system_administrator_password (Optional[PasswordForSystemAdministrator]):

        service_provider_administrator_password (Optional[PasswordForServiceProviderAdministrator]):

        group_administrator_password (Optional[PasswordForGroupAdministrator]):

        user_password (Optional[PasswordForUser]):

        access_device_authentication_password (Optional[PasswordForAccessDevice]):

        trunk_group_authentication_password (Optional[PasswordForTrunkGroup]):

    """

    system_administrator_password: Optional[PasswordForSystemAdministrator] = field(
        default=None, metadata={"alias": "systemAdministratorPassword"}
    )

    service_provider_administrator_password: Optional[
        PasswordForServiceProviderAdministrator
    ] = field(default=None, metadata={"alias": "serviceProviderAdministratorPassword"})

    group_administrator_password: Optional[PasswordForGroupAdministrator] = field(
        default=None, metadata={"alias": "groupAdministratorPassword"}
    )

    user_password: Optional[PasswordForUser] = field(
        default=None, metadata={"alias": "userPassword"}
    )

    access_device_authentication_password: Optional[PasswordForAccessDevice] = field(
        default=None, metadata={"alias": "accessDeviceAuthenticationPassword"}
    )

    trunk_group_authentication_password: Optional[PasswordForTrunkGroup] = field(
        default=None, metadata={"alias": "trunkGroupAuthenticationPassword"}
    )

Responses

Bases: OCIDataResponse

Response to the PasswordGenerateRequest. The response contains the requested passwords.

Attributes:

system_administrator_password (Optional[str]):

service_provider_administrator_password (Optional[str]):

group_administrator_password (Optional[str]):

user_password (Optional[str]):

user_passcode (Optional[str]):

user_sip_authentication_password (Optional[str]):

access_device_authentication_password (Optional[str]):

trunk_group_authentication_password (Optional[str]):

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

@dataclass(kw_only=True)
class PasswordGenerateResponse(OCIDataResponse):
    """Response to the PasswordGenerateRequest.
        The response contains the requested passwords.

    Attributes:

        system_administrator_password (Optional[str]):

        service_provider_administrator_password (Optional[str]):

        group_administrator_password (Optional[str]):

        user_password (Optional[str]):

        user_passcode (Optional[str]):

        user_sip_authentication_password (Optional[str]):

        access_device_authentication_password (Optional[str]):

        trunk_group_authentication_password (Optional[str]):

    """

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

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

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

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

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

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

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

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

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 PasswordGenerateRequest

client = Client()

command = PasswordGenerateRequest(
    system_administrator_password=...,
    service_provider_administrator_password=...,
    group_administrator_password=...,
    user_password=...,
    access_device_authentication_password=...,
    trunk_group_authentication_password=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("PasswordGenerateRequest",
    system_administrator_password=...,
    service_provider_administrator_password=...,
    group_administrator_password=...,
    user_password=...,
    access_device_authentication_password=...,
    trunk_group_authentication_password=...,
)

print(response)