UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest

Bases: OCIRequest

Delete a mobile identity from the user's list of mobile identities. The response is either a SuccessResponse or an ErrorResponse.

  An ErrorResponse will be returned if any device cannot be deleted because of insufficient privilege.
  When a delete request is attempted on the primary mobile identity, the delete will fail unless it is the last mobile identity in the user's list.

  If deleteExistingDevices is set to true, after the mobile identity is deleted, any device that is only used by the deleted mobile identity 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 with the type warning will be returned if any device cannot be deleted because of insufficient privilege.

Attributes:

  user_id (str):

  mobile_number (str):

  delete_existing_devices (Optional[bool]):

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

@dataclass(kw_only=True)
class UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest(OCIRequest):
    """Delete a mobile identity from the user's list of mobile identities.
          The response is either a SuccessResponse or an ErrorResponse.

          An ErrorResponse will be returned if any device cannot be deleted because of insufficient privilege.
          When a delete request is attempted on the primary mobile identity, the delete will fail unless it is the last mobile identity in the user's list.

          If deleteExistingDevices is set to true, after the mobile identity is deleted, any device that is only used by the deleted mobile identity 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 with the type warning will be returned if any device cannot be deleted because of insufficient privilege.

      Attributes:

          user_id (str):

          mobile_number (str):

          delete_existing_devices (Optional[bool]):

    """

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

    mobile_number: str = field(metadata={"alias": "mobileNumber"})

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

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

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

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 UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest

client = Client()

command = UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest(
    user_id=...,
    mobile_number=...,
    delete_existing_devices=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest",
    user_id=...,
    mobile_number=...,
    delete_existing_devices=...,
)

print(response)