GroupAdminAddRequest

Bases: OCIRequest

Add a group administrator. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

user_id (str):

first_name (Optional[str]):

last_name (Optional[str]):

password (Optional[str]):

language (Optional[str]):

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

@dataclass(kw_only=True)
class GroupAdminAddRequest(OCIRequest):
    """Add a group administrator.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        user_id (str):

        first_name (Optional[str]):

        last_name (Optional[str]):

        password (Optional[str]):

        language (Optional[str]):

    """

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

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

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

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

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

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

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

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 GroupAdminAddRequest

client = Client()

command = GroupAdminAddRequest(
    service_provider_id=...,
    group_id=...,
    user_id=...,
    first_name=...,
    last_name=...,
    password=...,
    language=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAdminAddRequest",
    service_provider_id=...,
    group_id=...,
    user_id=...,
    first_name=...,
    last_name=...,
    password=...,
    language=...,
)

print(response)