Skip to content

GroupAccessDeviceModifyUserRequest

Bases: OCIRequest

Request to modify attributes for line/ports assigned on the group device profile. The response is either SuccessResponse or ErrorResponse. The following elements are only used in XS data mode and ignored in AS data mode: privateIdentity

Attributes:

service_provider_id (str):

group_id (str):

device_name (str):

line_port (str):

private_identity (Optional[str]):

is_primary_line_port (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAccessDeviceModifyUserRequest(OCIRequest):
    """Request to modify attributes for line/ports assigned on the group device profile.
        The response is either SuccessResponse or ErrorResponse.
        The following elements are only used in XS data mode and ignored in AS data mode:
          privateIdentity

    Attributes:

        service_provider_id (str):

        group_id (str):

        device_name (str):

        line_port (str):

        private_identity (Optional[str]):

        is_primary_line_port (Optional[bool]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    device_name: str = field(metadata={"alias": "deviceName"})

    line_port: str = field(metadata={"alias": "linePort"})

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

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

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupAccessDeviceModifyUserRequest

client = Client()

command = GroupAccessDeviceModifyUserRequest(
    service_provider_id=...,
    group_id=...,
    device_name=...,
    line_port=...,
    private_identity=...,
    is_primary_line_port=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceModifyUserRequest",
    service_provider_id=...,
    group_id=...,
    device_name=...,
    line_port=...,
    private_identity=...,
    is_primary_line_port=...,
)

print(response)