Cloud Fax and Notifications Account API 2.6 Documentation
UserUpdate
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  UserUpdate  

19.2 UserUpdateRequest

UserUpdate Overview   UserUpdateResult

In general, the absence of an element that is an immediate child of UserUpdateRequest is taken to mean that the current value (or group of values) is to be unchanged.


Tag Name
& type
#Description
UserUpdateRequest   Namespace of this element is http://ws.easylink.com/UserUpdate/2011/01
   SubmitId
xs:string
0-1Optional string identifying request, which will be echoed in result.
   UserAlias
UserAliasType
1Identifies the user account to be updated. See UserAliasType.
   ParentEntityId
ParentIdentityType
0-1This is the parent (either group entity or customer) for the user to be updated.
For an F2M user, GroupEntityId must be present. If CustomerNumber is present, GroupEntityId must be a group under that customer. If CustomerNumber is not present, then the GroupEntityId must be a group under the effective requester's customer number.
For a non-F2M user, then GroupEntityId will be ignored if present. If CustomerNumber is present, then the user will be created under that customer. If CustomerNumber is not present, then the effective requester's customer will be used.
   CustomerNumber
xs:unsignedInt
0-1This is the customer number of user to be updated. If omitted, then the effective requester's customer is used.
   GroupEntityId
xs:unsignedInt
0-1This is the group to which the user is to be assigned. Only applies to an F2M user.
   Password
xs:string
0-1New password.
   UserName
EncodableStringType
0-1New user name. See EncodableStringType.
   UserAccountStatus
AcctServiceStatusType
0-1This is the account status of user. The legal values are:
  • active
  • cancelled
  • suspended
  • inactive
  • deleted
  • pending
  • hold
The default is "pending"
   UserAddress
AcctAddressType
0-1User address. See AcctAddressType.
   UserContact
AcctContactType
0-1User contact details. See AcctContactType.
   TechnicalAddress
AcctAddressType
0-1Address to be used for technical issues. See AcctAddressType.
Only applies to "regular" account
   TechnicalContact
AcctContactType
0-1Contact information for technical issues. See AcctContactType.
Only applies to "regular" account.
   ShippingAddress
AcctAddressType
0-1User shipping address. See AcctAddressType.
Only applies to "regular" account.
   Mbox
xs:boolean
0-1Indicates whether or not the user will have an XDDS "mailbox".
This element is ignored for F2M accounts.
   ReportAddress
DestinationType
0-1This is the report address for a user. See DestinationType.
This element currently has no effect for a UserUpdateRequest. When updating an F2M user account, use the UserContact/ContactEmail field to update this value. (A UserInfo result will still show the updated value as ReportAddress.)
For all user accounts, using ProfileUpdate to update the "admin_type" and "admin_to" profile fields has the effect of updating the ReportAddress.
   Fax2MailData0-1This only applies to an F2M user.
   Admin
xs:boolean
0-1This determines whether the F2M user is an administrator (default = false).
   AdminEntityId
xs:long
0-1If Admin is "true", this is the entity number of the group which the user administers.
   DefaultProfile
xs:int
0-1Currently, this value cannot be updated.
   UserExtensions
ExtensionType
0-1The name of the extension. Note that the value is case-sensitive. The following UserExtensions are currently defined:
SegmentPropertyDescription
USERPasswordManagementCertain older applications with customized access methods may require use of an older password control system. Specifying the value "false" here will avoid the current password management mechanisms.
 
    prev  next        Table of Contents  UserUpdate  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified October 06, 2020