Changing user properties

To modify a backup user, use the ModifyUser method. You can change the following properties:

  • Re-assign the user to another customer
  • Change the users name, title, email address or phone number
🚧

Usernames and passwords cannot be changed.

Required parameters

ParameterDescriptionSupported values
userInfoA group of parameters related to the userUserInfo (has child parameters of its own see the UserInfo child parameters table below)

UserInfo child parameters

ParameterDescriptionSupported values
IDThe ID number of the user<int> Integer
PartnerIdThe ID of the customer the user is created for (retrieved through the GetPartnerInfo method)<int> Integer
Name (required)A login name for the user (must be the same as the EmailAddress)OptionalNonEmptyString
PasswordSet a password for the new userOptionalNonEmptyString
RoleIdThe ID of the role the user will be given (retrieved through the enumerateUserRoles method)

<int> Integer

Choose Int that correlates to the role below:
  • 1 - SuperUser
  • 2 - Administrator
  • 3 - Manager
  • 4 - Operator
  • 5 - Supporter
  • 6 - Reporter
  • 7 - Notifier
ContactPersonIdThe ID of the contact person that this new user will be associated with<int> Integer
TwoFactorAuthenticationStatusAn array of 2FA state's to give to the new userTwoFactorAuthenticationState::Enum
  • Undefined
  • Disabled
  • Enabled
  • Count
EmailAddressThe email address of the user (must be the same as the Name given)<std::String>
FlagsFlag the user with certain feature accessUserFlag::FlagsType
  • Undefined
  • TeamViewer
  • AuthorizedSigner
  • Administrative
  • Technical
  • Sales
  • Billing
  • Count
FirstLoginTimeThe time-stamp of the first time the user has logged in successfully<std::time_t> Integer in Unix format. For example, 1535673599 stands for August 30, 2018
LastLoginTimeThe time-stamp of the last time the user has logged in successfully<std::time_t> Integer in Unix format. For example, 1535673599 stands for August 30, 2018
FirstNameThe first name of the user<std::String>
FullNameThe surname of the user<std::String>
TitleA title given to the user of the user<std::String>
PhoneNumberThe phone number of the user<std::String>

Sample request

{
    "jsonrpc":"2.0",
    "visa": "{{visa}}",
    "id":"jsonrpc",
    "method" : "ModifyUser",
    "params" : {
	"userInfo" : {
	    "Id" : 987654,
	    "RoleId" : 1,
	    "Flags": ["Technical","Sales"]
	}
    }
}

Sample response

{
    "id": "jsonrpc",
    "jsonrpc": "2.0",
    "result": null,
    "visa": "{{visa}}"
}

Did this page help you?