SystemAlternateUserIdGetListRequest

Bases: OCIRequest

Request to get the list of alternate user ids. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the alternate user ids in the administrator's reseller meeting the search criteria are returned.

The response is either SystemAlternateUserIdGetListResponse or ErrorResponse.

The following data elements are only used in AS data mode:
  searchCriteriaResellerId

Attributes:

response_size_limit (Optional[int]):

search_criteria_alternate_user_id (Optional[List[SearchCriteriaAlternateUserId]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

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

@dataclass(kw_only=True)
class SystemAlternateUserIdGetListRequest(OCIRequest):
    """Request to get the list of alternate user ids.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the alternate
        user ids in the administrator's reseller meeting the search criteria are returned.

        The response is either SystemAlternateUserIdGetListResponse or ErrorResponse.

        The following data elements are only used in AS data mode:
          searchCriteriaResellerId

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_alternate_user_id (Optional[List[SearchCriteriaAlternateUserId]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

    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"}
    )

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

Responses

Bases: OCIDataResponse

Response to SystemAlternateUserIdGetListRequest. 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", "Group Id", "Organization Id", "Reseller Id" and "User Type".

The following columns are only returned in AS data mode:
  "Reseller Id"

Attributes:

alternate_user_id_table (OCITable):

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

@dataclass(kw_only=True)
class SystemAlternateUserIdGetListResponse(OCIDataResponse):
    """Response to SystemAlternateUserIdGetListRequest.
        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\", \"Group Id\", \"Organization Id\", \"Reseller Id\" and \"User Type\".

        The following columns are only returned in AS data mode:
          \"Reseller Id\"

    Attributes:

        alternate_user_id_table (OCITable):

    """

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

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 SystemAlternateUserIdGetListRequest

client = Client()

command = SystemAlternateUserIdGetListRequest(
    response_size_limit=...,
    search_criteria_alternate_user_id=...,
    search_criteria_user_id=...,
    search_criteria_group_id=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemAlternateUserIdGetListRequest",
    response_size_limit=...,
    search_criteria_alternate_user_id=...,
    search_criteria_user_id=...,
    search_criteria_group_id=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

print(response)