UserModify

Top  Previous  Next

SOAP

UserModify( aHandle, 

                aUserGroupName, aUserLogin, 

                &aNewUserLogin, aFullUserName, aUserPassword, 

                aCanAdminGroup, aCanEditData,

                aCanLoginAsSOAP, aCanBeCloned, 

                &aErrorMsg );

 

REST

/UserModify?Handle=<value>&UserGroup=<value>&UserLogin=<value>

                &NewUserLogin=<value>&FullUserName=<value>&UserPassword=<value>

                &CanAdminGroup=<value>&CanEditData=<value>

                &CanLoginAsSOAP=<value>&CanBeCloned=<value>

returns NewUserLogin, aErrorMsg

 

Description: UserModify() is used to change the login, full name, password and admin status for the specified account.  This function will fail if the account does not exist in the specified group.

 

aHandle The value created in the call to Login().

aUserGroupName The user group that the user exists in.

aUserLogin The existing login for this account.

&aNewUserLogin The desired login for this account.  This value may return as a different name if the specified login contained invalid characters or if the specified login already exists.

aUserFullName Is the name of the user for this account.  This is simply a descriptive field not used in the authentication process.  If this parameter is left blank, no changes are made to the field.

aUserPassword The desired new password for this account. If this parameter is left blank, no changes are made to the field.

aCanAdminGroup Determines if this account should have group administrative privileges .

aCanEditData Determines if this account should be allowed to access the Data Entry screens .

aCanLoginAsRA Determines if this account should allow Remote Access logins.

aCanBeCloned Determines if this account can be cloned (i.e. for use with LoginAsClone)

&aErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

 

Example: UserModify( lHandle, "DOT@NY", "Scott", "Richard", "Richard Scott Miller", "djdekkslla=", false, false, false, false, lErrorMsg );