REST API - set
  1. Operations
  2. appliance
  3. techpreview
  4. localaccounts
  5. user

appliance techpreview localaccounts user: set

Update local user account properties role, full name, enabled status and password

Request:

HTTP request

PUT https://{server}/rest/appliance/techpreview/local-accounts/user

Request Body Structure:

{
    "config" : {
        "role" : "admin",
        "fullname" : "string",
        "email" : "string",
        "username" : "string",
        "status" : "disabled"
    }
}

Request Body Parameters:

Name Type Description
bold = required
config user_config User configuration.
config.username string User login name
config.role string User roles

Defines user roles for appliance Value is one of:
admin: Able to configure the appliance.
operator: Able to read the appliance configuration.
superAdmin: Able to configure the appliance, manage local accounts and use the BASH shell
config.fullname string User full name
config.status string Enabled status of the local account

Defines status of user accounts Value is one of:
disabled: The user account is disabled.
enabled: The user account is enabled.
config.email string email of the local account

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error