REST API Method: POST /rest/localuser/{identifier}

Modifies a Local Users Table given a specific Table ID.

URL:

https://192.168.0.111/rest/localuser/{identifier}

HTTP Method

POST

Requires Authentication:

true

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Specifies the Administrative State of the resource.
UsernameYesNostringnone32 - Max Length Specifies the name of user.
PasswordNoNostringnone128 - Max Length Specifies the password of user.
GroupYesNoEnum0Possible values:
  • 0 - eUAAudit
  • 1 - eUAReadOnly
  • 2 - eUAOperator
  • 3 - eUAAdministrator
  • 4 - eUARejectUser
  • 5 - eUAWebServices
Specifies the access level to be granted to the user.
AccountActiveYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether the user account is active or not. This is applicable for POST (modify user) operation and GET operation.
PassExpiresYesNostringnone32 - Max Length Specifies the number of days until the current password expires for the indicated user. UserAuth determines the password expiration based on Global Security configuration.
ForcePasswordChangeOnLoginNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
PeerSweliteIDNoNostringnone41 - Max Length Specifies the SWe Edge ID of the active HA instance.
NumberActiveSessionsNoNoint0 Indicates the number of active user sessions.

Helpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

  • No labels