UserPrimaryEndpointAdvancedSettingGetRequest

Bases: OCIRequest

Get the Users Primary Endpoint setting. The response is either a UserPrimaryEndpointAdvancedSettingGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserPrimaryEndpointAdvancedSettingGetRequest(OCIRequest):
    """Get the Users Primary Endpoint setting.
        The response is either a UserPrimaryEndpointAdvancedSettingGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserPrimaryEndpointAdvancedSettingGetRequest.

Attributes:

allow_origination (bool):

allow_termination (bool):

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

@dataclass(kw_only=True)
class UserPrimaryEndpointAdvancedSettingGetResponse(OCIDataResponse):
    """Response to the UserPrimaryEndpointAdvancedSettingGetRequest.

    Attributes:

        allow_origination (bool):

        allow_termination (bool):

    """

    allow_origination: bool = field(metadata={"alias": "allowOrigination"})

    allow_termination: bool = field(metadata={"alias": "allowTermination"})

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 UserPrimaryEndpointAdvancedSettingGetRequest

client = Client()

command = UserPrimaryEndpointAdvancedSettingGetRequest(
    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("UserPrimaryEndpointAdvancedSettingGetRequest",
    user_id=...,
)

print(response)