alterAccount

Alter an existing account

The "alterAccount" action alters an account that an application or user can use to log into the server. The account you want altered is specified with the "username" property. To receive privileges, an account is assigned to one or more roles - see the action "assignRolesToAccounts".

 

Request examples

Maximal

{
  "action": "alterAccount",
  "params": {
    "username": "AccountToBeAltered",
    "newPassword": "NewPasswordForSpecifiedAccount",
    "accountDescription": "New description for the specified account",
    "enableDatetime": "2023-01-01",
    "disableDatetime": "2033-12-31",
    "lockoutAfterNFailedAttempts": 5,
    "maxDaysBeforePasswordMustChange": 365,
    "maxMinutesBeforeNextLogin": 0,
    "memoryLimit": 1048576,
    "memoryRule": "default"
  },
  "requestId": "1",
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

Minimal

{
  "action": "alterAccount",
  "params": {
    "username": "AccountToBeAltered",
"newPassword": "NewPasswordForSpecifiedAccount" }, "authToken": "replaceWithAuthTokenFromCreateSession" }
 
 

 

Properties

Request properties ("params")

Property Default Type Limits (inclusive)

accountDescription

Optional with default of "" string 0 to 65,500 bytes

disableDatetime

Optional with default of "" date Any date after "0336-10-07"

enableDatetime

Optional with default of "" date Any date after "0336-10-07"

lockoutAfterNFailedAttempts

Optional with default of the session's "LOGON_FAIL_LIMIT" property integer 0 to 2147483647

maxDaysBeforePasswordMustChange

Optional with default of "" integer 0 to 2147483647

maxMinutesBeforeNextLogin

Optional with default of the session's "LOGON_MUST_TIME" property integer 0 to 35791394

memoryLimit

Optional with default of the session's "USR_MEMORY" property integer 0 to 2147483647

memoryRule

Optional with default of the session's "USR_MEM_RULE" property string

"default"

"absolute"

"guideline"

newPassword

Optional with default of "".

Required for the "createSession" action

string 0 to 256 bytes

username

Required - No default value

 

Optional with default of the account name of the currently logged-in user for Key-Value actions

 

string 1 to 64 bytes