GroupAlternateUserIdGetListRequest

Bases: OCIRequest

Request to get the list of alternate user ids in the group. The response is either GroupAlternateUserIdGetListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_size_limit (Optional[int]):

search_criteria_alternate_user_id (Optional[List[SearchCriteriaAlternateUserId]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

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

@dataclass(kw_only=True)
class GroupAlternateUserIdGetListRequest(OCIRequest):
    """Request to get the list of alternate user ids in the group.
        The response is either GroupAlternateUserIdGetListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_size_limit (Optional[int]):

        search_criteria_alternate_user_id (Optional[List[SearchCriteriaAlternateUserId]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

    """

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

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

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_alternate_user_id: Optional[List[SearchCriteriaAlternateUserId]] = (
        field(default=None, metadata={"alias": "searchCriteriaAlternateUserId"})
    )

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

Responses

Bases: OCIDataResponse

Response to GroupAlternateUserIdGetListRequest. The "User Type" column contains the corresponding enumerated UserType value. Contains a table of alternate user ids, the column headings are: "User Id", "Alternate User Id" and "User Type".

Attributes:

alternate_user_id_table (OCITable):

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

@dataclass(kw_only=True)
class GroupAlternateUserIdGetListResponse(OCIDataResponse):
    """Response to GroupAlternateUserIdGetListRequest.
        The \"User Type\" column contains the corresponding enumerated UserType value.
        Contains a table of alternate user ids, the column headings are:
          \"User Id\", \"Alternate User Id\" and \"User Type\".

    Attributes:

        alternate_user_id_table (OCITable):

    """

    alternate_user_id_table: OCITable = field(
        metadata={"alias": "alternateUserIdTable"}
    )

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 GroupAlternateUserIdGetListRequest

client = Client()

command = GroupAlternateUserIdGetListRequest(
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_alternate_user_id=...,
    search_criteria_user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAlternateUserIdGetListRequest",
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_alternate_user_id=...,
    search_criteria_user_id=...,
)

print(response)