UserAlternateUserIdGetListRequest

Bases: OCIRequest

Request to get the user id and the list of alternate user ids of an user. The response is either UserAlternateUserIdGetListResponse or ErrorResponse. The "userId" can be either the user Id or an alternate user Id.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserAlternateUserIdGetListRequest(OCIRequest):
    """Request to get the user id and the list of alternate user ids of an user.
        The response is either UserAlternateUserIdGetListResponse or ErrorResponse.
        The \"userId\" can be either the user Id or an alternate user Id.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserAlternateUserIdGetListRequest. Contains a table of the main user id and the alternate user ids, the column headings are: "User Id", "Description", "Alternate". The possible values for "Alternate" are "true" and "false". The "Description" is only present for alternate user Ids.

Attributes:

user_id_table (OCITable):

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

@dataclass(kw_only=True)
class UserAlternateUserIdGetListResponse(OCIDataResponse):
    """Response to UserAlternateUserIdGetListRequest.
        Contains a table of the main user id and the alternate user ids, the column headings are: \"User Id\", \"Description\", \"Alternate\".
        The possible values for \"Alternate\" are \"true\" and \"false\".
        The \"Description\" is only present for alternate user Ids.

    Attributes:

        user_id_table (OCITable):

    """

    user_id_table: OCITable = field(metadata={"alias": "userIdTable"})

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 UserAlternateUserIdGetListRequest

client = Client()

command = UserAlternateUserIdGetListRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserAlternateUserIdGetListRequest",
    user_id=...,
)

print(response)