GroupVirtualOnNetEnterpriseExtensionsAddUserRequest

Bases: OCIRequest

Adds Virtual On-Net users to a Group. It is possible to add either: a single user, or a list of users, or a range of users, or any combination thereof. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

virtual_on_net_user (Optional[List[VirtualOnNetUser]]):

virtual_on_net_user_range (Optional[VirtualOnNetUserRange]):

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

@dataclass(kw_only=True)
class GroupVirtualOnNetEnterpriseExtensionsAddUserRequest(OCIRequest):
    """Adds Virtual On-Net users to a Group. It is possible to add
        either: a single user,  or a list of users, or a range of users,
        or any combination thereof.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        virtual_on_net_user (Optional[List[VirtualOnNetUser]]):

        virtual_on_net_user_range (Optional[VirtualOnNetUserRange]):

    """

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

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

    virtual_on_net_user: Optional[List[VirtualOnNetUser]] = field(
        default=None, metadata={"alias": "virtualOnNetUser"}
    )

    virtual_on_net_user_range: Optional[VirtualOnNetUserRange] = field(
        default=None, metadata={"alias": "virtualOnNetUserRange"}
    )

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 GroupVirtualOnNetEnterpriseExtensionsAddUserRequest

client = Client()

command = GroupVirtualOnNetEnterpriseExtensionsAddUserRequest(
    service_provider_id=...,
    group_id=...,
    virtual_on_net_user=...,
    virtual_on_net_user_range=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupVirtualOnNetEnterpriseExtensionsAddUserRequest",
    service_provider_id=...,
    group_id=...,
    virtual_on_net_user=...,
    virtual_on_net_user_range=...,
)

print(response)