UserConsolidatedDeleteRequest

Bases: OCIRequest

Request to delete a user.

If deleteExistingDevices is set to true, after the user is deleted, any device that is only used by the deleted user prior to the deletion will be deleted if the command is executed with the correct priviledge.
 Group administrator or above running this command can delete any group level devices. Service provider administrator or above can delete any service provider and group devices. Provisioning administrator or above can delete any devices.
 An ErrorResponse will be returned if any device cannot be deleted because of insufficient privilege.

 If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above.
  When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above.
  When omitted, the number(s) will be left assigned to the group.
 An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege.

Attributes:

user_id (str):

delete_existing_devices (Optional[bool]):

unassign_phone_numbers (Optional[str]):

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

@dataclass(kw_only=True)
class UserConsolidatedDeleteRequest(OCIRequest):
    """Request to delete a user.

        If deleteExistingDevices is set to true, after the user is deleted, any device that is only used by the deleted user prior to the deletion will be deleted if the command is executed with the correct priviledge.
         Group administrator or above running this command can delete any group level devices. Service provider administrator or above can delete any service provider and group devices. Provisioning administrator or above can delete any devices.
         An ErrorResponse will be returned if any device cannot be deleted because of insufficient privilege.

         If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above.
          When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above.
          When omitted, the number(s) will be left assigned to the group.
         An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege.

    Attributes:

        user_id (str):

        delete_existing_devices (Optional[bool]):

        unassign_phone_numbers (Optional[str]):

    """

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

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

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

Responses

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

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 UserConsolidatedDeleteRequest

client = Client()

command = UserConsolidatedDeleteRequest(
    user_id=...,
    delete_existing_devices=...,
    unassign_phone_numbers=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserConsolidatedDeleteRequest",
    user_id=...,
    delete_existing_devices=...,
    unassign_phone_numbers=...,
)

print(response)