UserIntegratedIMPModifyRequest

Bases: OCIRequest

Modifies the Integrated IMP specific service attribute for the user. The response is either a SuccessResponse or an ErrorResponse. If the impId element is set in the request, the impId element does not take effect on the service for the user unless the request also has the isActive element set to true to turn the service from off to on. If impId is based on an alternate user ID and the impId and userId are identical, isAlternateImpId should be set to true to determine that impId is the user's alternate ID. The following elements are only used in AS data mode and ignored in XS data mode: impId isAlternateImpId

Attributes:

user_id (str):

is_active (Optional[bool]):

imp_id (Optional[str]):

is_alternate_imp_id (Optional[bool]):

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

@dataclass(kw_only=True)
class UserIntegratedIMPModifyRequest(OCIRequest):
    """Modifies the Integrated IMP specific service attribute for the user.
        The response is either a SuccessResponse or an ErrorResponse.
        If the impId element is set in the request, the impId element does
        not take effect on the service for the user unless the request also
        has the isActive element set to true to turn the service from off
        to on.
        If impId is based on an alternate user ID and the impId and userId
        are identical, isAlternateImpId should be set to true to determine
        that impId is the user's alternate ID.
        The following elements are only used in AS data mode and ignored in
        XS data mode:
          impId
          isAlternateImpId

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        imp_id (Optional[str]):

        is_alternate_imp_id (Optional[bool]):

    """

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

    is_active: Optional[bool] = field(default=None, metadata={"alias": "isActive"})

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

    is_alternate_imp_id: Optional[bool] = field(
        default=None, metadata={"alias": "isAlternateImpId"}
    )

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 UserIntegratedIMPModifyRequest

client = Client()

command = UserIntegratedIMPModifyRequest(
    user_id=...,
    is_active=...,
    imp_id=...,
    is_alternate_imp_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserIntegratedIMPModifyRequest",
    user_id=...,
    is_active=...,
    imp_id=...,
    is_alternate_imp_id=...,
)

print(response)