Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagec#
title Method
public AuthServerResponse DeleteUserUpdateUser(string authServerPartnerLoginName, 
                 string authServerPartnerLoginPassword, 
                 string authServerPartnerUserLoginName,
                 string firstName,
                 string lastName,
                 string mobile,
                 string email,
                 string pw, 
bool removeRelated                 short  userStatus)


WCF parameterdata typedescription
authServerPartnerLoginNamestring
SurePassId
SurePassID account login name
authServerPartnerLoginPasswordstring
SurePassId
SurePassID account login key
authServerPartnerUserLoginNamestringUser account login name
removeRelatedboolIn addition to deleting the user al other references to the user such as audit trail will be removed from the system.
firstNamestringFirst name. Empty value leaves the current value as is.
lastNamestringLast Name. Empty value leaves the current value as is.
mobilestringMobile device number. The  format is: +aaa(bbb)cccccccc where aaa is country code , bbb is area code and ccccccc is the local number. For example.  US: +1(800)200-8411 UK: +44(0)20 1234 5678. Empty value leaves the current value as is.
emailstringEmail. Empty value leaves the current value as is.
pwstringUsers new password. This can be plain text or hash. In either case, the password will be encrypted by the server. Empty value leaves the current value as is.
userStatusshort0 - user is enabled, 1 - user is disabled


Code Block
languagec#
titleSample WCF C# Method
AuthServerResponse  resp = DeleteUserUpdateUser("accountLogin",             
            "accountKey", 
            "Mandy", 
             false
            );

...

Code Block
languagec#
titleSample WCF C# Repsonse
 if (resp.ErrorCode != 0)  {      
       message.Text = resp.ErrorMsg;
       return false;
 }


REST


REST parameterdata typedescription
spAccountLoginNamestring
SurePassId
SurePassID account login name
spAccountLoginKeystring
SurePassId removeRelatedboolIn addition to deleting the user,  all other references to the user such as audit trail will be removed from the system.
SurePassID account login key
usernamestringuser account login name
typestring
delete_user
update_user
firstNamestringFirst name. If omitted, the value is not updated.
lastNamestringLast Name. If omitted, the value is not updated.
mobilestringMobile device number. The  format is: +aaa(bbb)cccccccc where aaa is country code , bbb is area code and ccccccc is the local number. For example.  US: +1(800)200-8411 UK: +44(0)20 1234 5678. If omitted, the value is not updated.
emailstringEmail. If omitted, the value is not updated.
pwstringUsers new password. This can be plain text or hash. In either case, the password will be encrypted by the server. If omitted, the value is not updated.
userStatusshort0 - user is enabled, 1 - user is disabled


Code Block
languagejs
titleSample REST/Json Method
 {  
  "username": "Mandy",
  "spAccountLoginName": "accountLogin",
  "spAccountLoginKey": "accountKey",
  "firstName": "New First Name",
  "lastName": "New Last "removeRelatedName",        // do not update this leave it as it is.
  "mobile": "+1(345)123-4567",
  "email": "false",
  mandy@newco.com",
  "userStatus": 0,                    // enabled 
  "type": "deleteupdate_user",


}


Code Block
languagejs
titleSample REST/Json Response
 {
  "errorCode": 0,
  "errorMessage": "OK",
  "type": "deleteupdate_user"
}