Skip to content

UserConsolidatedModifyRequest22

Bases: OCIRequest

Request to modify a user.

If deleteExistingDevices is set to true, when the devices for the main endpoint or SCA service are changed, devices with no more endpoint will be deleted if the command is executed with the correct privilege.
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.

When phone numbers are un-assigned from the user, the unused numbers may be un-assigned from the group and service provider. 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.

If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if needed if the command is executed by a service provider administrator and above. The command will fail otherwise.

Alternate user ids can be added by a group level administrator or above.

The password is not required if external authentication is enabled.
When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance service is not assigned after this request, the request will fail.

The userService/servicePackwill be authorized to the group if it has not been authorized to the group and the command is excuted by a service provider administrator. The request will fail otherwise.
If not present, the authorizedQuantity will be set to unlimited if allowed.

If any of the third party voice mail elements are included but the service is not assigned after this request, the request will fail.

 If the sip authentication elements are included but the SPI Authentication service is not assigned after this request, the request will fail.

 If the impPassword element is included but the Integrated IMP service is not assigned after this request, the request will fail.


 The following elements are ignored in XS data mode:
  nameDialingName
  alternateUserIdList
  passcode
  trunkAddressing
  thirdPartyVoiceMailServerSelection
  thirdPartyVoiceMailServerUserServer
  thirdPartyVoiceMailServerMailboxIdType
  thirdPartyVoiceMailMailboxURL
  sipAuthenticationData
  newUserExternalId

 The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

delete_existing_devices (Optional[bool]):

unassign_phone_numbers (Optional[str]):

add_phone_number_to_group (Optional[bool]):

new_user_id (Optional[str]):

last_name (Optional[str]):

first_name (Optional[str]):

calling_line_id_last_name (Optional[str]):

calling_line_id_first_name (Optional[str]):

name_dialing_name (Optional[Nillable[NameDialingName]]):

hiragana_last_name (Optional[str]):

hiragana_first_name (Optional[str]):

phone_number (Optional[Nillable[str]]):

alternate_user_id_list (Optional[Nillable[ReplacementAlternateUserIdEntryList]]):

extension (Optional[Nillable[str]]):

calling_line_id_phone_number (Optional[Nillable[str]]):

old_password (Optional[str]):

new_password (Optional[Nillable[str]]):

department (Optional[Nillable[DepartmentKey]]):

language (Optional[str]):

time_zone (Optional[str]):

sip_alias_list (Optional[Nillable[ReplacementSIPAliasList]]):

endpoint (Optional[Nillable[Union[ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactModify, TrunkAddressingMultipleContactModify]]]):

shared_call_appearance_access_device_endpoint_list (Optional[Nillable[ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22]]):

title (Optional[Nillable[str]]):

pager_phone_number (Optional[Nillable[str]]):

mobile_phone_number (Optional[Nillable[str]]):

email_address (Optional[Nillable[str]]):

yahoo_id (Optional[Nillable[str]]):

address_location (Optional[Nillable[str]]):

address (Optional[StreetAddress]):

network_class_of_service (Optional[str]):

user_service_list (Optional[Nillable[ReplacementConsolidatedUserServiceAssignmentList]]):

service_pack_list (Optional[Nillable[ReplacementConsolidatedServicePackAssignmentList]]):

third_party_voice_mail_server_selection (Optional[str]):

third_party_voice_mail_server_user_server (Optional[Nillable[str]]):

third_party_voice_mail_server_mailbox_id_type (Optional[str]):

third_party_voice_mail_mailbox_url (Optional[Nillable[str]]):

sip_authentication_user_name (Optional[str]):

new_sip_authentication_password (Optional[str]):

old_sip_authentication_password (Optional[str]):

new_passcode (Optional[str]):

old_passcode (Optional[str]):

imp_password (Optional[Nillable[str]]):

new_user_external_id (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
106338
106339
106340
106341
106342
106343
106344
106345
106346
106347
106348
106349
106350
106351
106352
106353
106354
106355
106356
106357
106358
106359
106360
106361
106362
106363
106364
106365
106366
106367
106368
106369
106370
106371
106372
106373
106374
106375
106376
106377
106378
106379
106380
106381
106382
106383
106384
106385
106386
106387
106388
106389
106390
106391
106392
106393
106394
106395
106396
106397
106398
106399
106400
106401
106402
106403
106404
106405
106406
106407
106408
106409
106410
106411
106412
106413
106414
106415
106416
106417
106418
106419
106420
106421
106422
106423
106424
106425
106426
106427
106428
106429
106430
106431
106432
106433
106434
106435
106436
106437
106438
106439
106440
106441
106442
106443
106444
106445
106446
106447
106448
106449
106450
106451
106452
106453
106454
106455
106456
106457
106458
106459
106460
106461
106462
106463
106464
106465
106466
106467
106468
106469
106470
106471
106472
106473
106474
106475
106476
106477
106478
106479
106480
106481
106482
106483
106484
106485
106486
106487
106488
106489
106490
106491
106492
106493
106494
106495
106496
106497
106498
106499
106500
106501
106502
106503
106504
106505
106506
106507
106508
106509
106510
106511
106512
106513
106514
106515
106516
106517
106518
106519
106520
106521
106522
106523
106524
106525
106526
106527
106528
106529
106530
106531
106532
106533
106534
106535
106536
106537
106538
106539
106540
106541
106542
106543
106544
106545
106546
106547
106548
106549
106550
106551
106552
106553
106554
106555
106556
106557
106558
106559
106560
106561
106562
106563
106564
106565
106566
106567
106568
106569
106570
106571
106572
106573
106574
106575
106576
106577
106578
106579
106580
106581
106582
106583
106584
106585
106586
106587
106588
106589
106590
106591
106592
106593
106594
106595
106596
106597
106598
106599
106600
106601
106602
106603
106604
106605
106606
106607
106608
106609
106610
106611
106612
106613
106614
106615
106616
106617
106618
106619
106620
106621
106622
106623
106624
106625
106626
106627
106628
106629
106630
106631
106632
106633
106634
106635
106636
106637
106638
106639
106640
106641
106642
106643
106644
106645
106646
106647
106648
106649
106650
106651
106652
106653
106654
106655
106656
106657
106658
106659
106660
106661
106662
106663
106664
106665
106666
106667
106668
106669
106670
106671
106672
106673
106674
@dataclass(kw_only=True)
class UserConsolidatedModifyRequest22(OCIRequest):
    """Request to modify a user.

        If deleteExistingDevices is set to true, when the devices for the main endpoint or SCA service are changed, devices with no more endpoint will be deleted if the command is executed with the correct privilege.
        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.

        When phone numbers are un-assigned from the user, the unused numbers may be un-assigned from the group and service provider. 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.

       If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if needed if the command is executed by a service provider administrator and above. The command will fail otherwise.

        Alternate user ids can be added by a group level administrator or above.

        The password is not required if external authentication is enabled.
        When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance service is not assigned after this request, the request will fail.

        The userService/servicePackwill be authorized to the group if it has not been authorized to the group and the command is excuted by a service provider administrator. The request will fail otherwise.
        If not present, the authorizedQuantity will be set to unlimited if allowed.

        If any of the third party voice mail elements are included but the service is not assigned after this request, the request will fail.

         If the sip authentication elements are included but the SPI Authentication service is not assigned after this request, the request will fail.

         If the impPassword element is included but the Integrated IMP service is not assigned after this request, the request will fail.


         The following elements are ignored in XS data mode:
          nameDialingName
          alternateUserIdList
          passcode
          trunkAddressing
          thirdPartyVoiceMailServerSelection
          thirdPartyVoiceMailServerUserServer
          thirdPartyVoiceMailServerMailboxIdType
          thirdPartyVoiceMailMailboxURL
          sipAuthenticationData
          newUserExternalId

         The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        delete_existing_devices (Optional[bool]):

        unassign_phone_numbers (Optional[str]):

        add_phone_number_to_group (Optional[bool]):

        new_user_id (Optional[str]):

        last_name (Optional[str]):

        first_name (Optional[str]):

        calling_line_id_last_name (Optional[str]):

        calling_line_id_first_name (Optional[str]):

        name_dialing_name (Optional[Nillable[NameDialingName]]):

        hiragana_last_name (Optional[str]):

        hiragana_first_name (Optional[str]):

        phone_number (Optional[Nillable[str]]):

        alternate_user_id_list (Optional[Nillable[ReplacementAlternateUserIdEntryList]]):

        extension (Optional[Nillable[str]]):

        calling_line_id_phone_number (Optional[Nillable[str]]):

        old_password (Optional[str]):

        new_password (Optional[Nillable[str]]):

        department (Optional[Nillable[DepartmentKey]]):

        language (Optional[str]):

        time_zone (Optional[str]):

        sip_alias_list (Optional[Nillable[ReplacementSIPAliasList]]):

        endpoint (Optional[Nillable[Union[ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactModify, TrunkAddressingMultipleContactModify]]]):

        shared_call_appearance_access_device_endpoint_list (Optional[Nillable[ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22]]):

        title (Optional[Nillable[str]]):

        pager_phone_number (Optional[Nillable[str]]):

        mobile_phone_number (Optional[Nillable[str]]):

        email_address (Optional[Nillable[str]]):

        yahoo_id (Optional[Nillable[str]]):

        address_location (Optional[Nillable[str]]):

        address (Optional[StreetAddress]):

        network_class_of_service (Optional[str]):

        user_service_list (Optional[Nillable[ReplacementConsolidatedUserServiceAssignmentList]]):

        service_pack_list (Optional[Nillable[ReplacementConsolidatedServicePackAssignmentList]]):

        third_party_voice_mail_server_selection (Optional[str]):

        third_party_voice_mail_server_user_server (Optional[Nillable[str]]):

        third_party_voice_mail_server_mailbox_id_type (Optional[str]):

        third_party_voice_mail_mailbox_url (Optional[Nillable[str]]):

        sip_authentication_user_name (Optional[str]):

        new_sip_authentication_password (Optional[str]):

        old_sip_authentication_password (Optional[str]):

        new_passcode (Optional[str]):

        old_passcode (Optional[str]):

        imp_password (Optional[Nillable[str]]):

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

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

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

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

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

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

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

    name_dialing_name: Optional[Nillable[NameDialingName]] = field(
        default=None, metadata={"alias": "nameDialingName"}
    )

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

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

    phone_number: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "phoneNumber"}
    )

    alternate_user_id_list: Optional[Nillable[ReplacementAlternateUserIdEntryList]] = (
        field(default=None, metadata={"alias": "alternateUserIdList"})
    )

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

    calling_line_id_phone_number: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "callingLineIdPhoneNumber"}
    )

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

    new_password: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "newPassword"}
    )

    department: Optional[Nillable[DepartmentKey]] = field(
        default=None, metadata={"alias": "department"}
    )

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

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

    sip_alias_list: Optional[Nillable[ReplacementSIPAliasList]] = field(
        default=None, metadata={"alias": "sipAliasList"}
    )

    endpoint: Optional[
        Nillable[
            Union[
                ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactModify,
                TrunkAddressingMultipleContactModify,
            ]
        ]
    ] = field(default=None, metadata={"alias": "endpoint"})

    shared_call_appearance_access_device_endpoint_list: Optional[
        Nillable[
            ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22
        ]
    ] = field(
        default=None, metadata={"alias": "sharedCallAppearanceAccessDeviceEndpointList"}
    )

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

    pager_phone_number: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "pagerPhoneNumber"}
    )

    mobile_phone_number: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "mobilePhoneNumber"}
    )

    email_address: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "emailAddress"}
    )

    yahoo_id: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "yahooId"}
    )

    address_location: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "addressLocation"}
    )

    address: Optional[StreetAddress] = field(
        default=None, metadata={"alias": "address"}
    )

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

    user_service_list: Optional[
        Nillable[ReplacementConsolidatedUserServiceAssignmentList]
    ] = field(default=None, metadata={"alias": "userServiceList"})

    service_pack_list: Optional[
        Nillable[ReplacementConsolidatedServicePackAssignmentList]
    ] = field(default=None, metadata={"alias": "servicePackList"})

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

    third_party_voice_mail_server_user_server: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "thirdPartyVoiceMailServerUserServer"}
    )

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

    third_party_voice_mail_mailbox_url: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "thirdPartyVoiceMailMailboxURL"}
    )

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

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

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

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

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

    imp_password: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "impPassword"}
    )

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

    def __post_init__(self):
        nillable_fields = [
            "name_dialing_name",
            "phone_number",
            "alternate_user_id_list",
            "extension",
            "calling_line_id_phone_number",
            "new_password",
            "department",
            "sip_alias_list",
            "endpoint",
            "shared_call_appearance_access_device_endpoint_list",
            "title",
            "pager_phone_number",
            "mobile_phone_number",
            "email_address",
            "yahoo_id",
            "address_location",
            "user_service_list",
            "service_pack_list",
            "third_party_voice_mail_server_user_server",
            "third_party_voice_mail_mailbox_url",
            "imp_password",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

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 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 UserConsolidatedModifyRequest22

client = Client()

command = UserConsolidatedModifyRequest22(
    user_id=...,
    delete_existing_devices=...,
    unassign_phone_numbers=...,
    add_phone_number_to_group=...,
    new_user_id=...,
    last_name=...,
    first_name=...,
    calling_line_id_last_name=...,
    calling_line_id_first_name=...,
    name_dialing_name=...,
    hiragana_last_name=...,
    hiragana_first_name=...,
    phone_number=...,
    alternate_user_id_list=...,
    extension=...,
    calling_line_id_phone_number=...,
    old_password=...,
    new_password=...,
    department=...,
    language=...,
    time_zone=...,
    sip_alias_list=...,
    endpoint=...,
    shared_call_appearance_access_device_endpoint_list=...,
    title=...,
    pager_phone_number=...,
    mobile_phone_number=...,
    email_address=...,
    yahoo_id=...,
    address_location=...,
    address=...,
    network_class_of_service=...,
    user_service_list=...,
    service_pack_list=...,
    third_party_voice_mail_server_selection=...,
    third_party_voice_mail_server_user_server=...,
    third_party_voice_mail_server_mailbox_id_type=...,
    third_party_voice_mail_mailbox_url=...,
    sip_authentication_user_name=...,
    new_sip_authentication_password=...,
    old_sip_authentication_password=...,
    new_passcode=...,
    old_passcode=...,
    imp_password=...,
    new_user_external_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserConsolidatedModifyRequest22",
    user_id=...,
    delete_existing_devices=...,
    unassign_phone_numbers=...,
    add_phone_number_to_group=...,
    new_user_id=...,
    last_name=...,
    first_name=...,
    calling_line_id_last_name=...,
    calling_line_id_first_name=...,
    name_dialing_name=...,
    hiragana_last_name=...,
    hiragana_first_name=...,
    phone_number=...,
    alternate_user_id_list=...,
    extension=...,
    calling_line_id_phone_number=...,
    old_password=...,
    new_password=...,
    department=...,
    language=...,
    time_zone=...,
    sip_alias_list=...,
    endpoint=...,
    shared_call_appearance_access_device_endpoint_list=...,
    title=...,
    pager_phone_number=...,
    mobile_phone_number=...,
    email_address=...,
    yahoo_id=...,
    address_location=...,
    address=...,
    network_class_of_service=...,
    user_service_list=...,
    service_pack_list=...,
    third_party_voice_mail_server_selection=...,
    third_party_voice_mail_server_user_server=...,
    third_party_voice_mail_server_mailbox_id_type=...,
    third_party_voice_mail_mailbox_url=...,
    sip_authentication_user_name=...,
    new_sip_authentication_password=...,
    old_sip_authentication_password=...,
    new_passcode=...,
    old_passcode=...,
    imp_password=...,
    new_user_external_id=...,
)

print(response)