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

appliance techpreview localaccounts user: list

List of local accounts

Request:

HTTP request

GET https://{server}/rest/appliance/techpreview/local-accounts/user
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "role" : "admin",
            "passwordstatus" : "notset",
            "fullname" : "string",
            "email" : "string",
            "username" : "string",
            "status" : "disabled"
        },
        {
            "role" : "admin",
            "passwordstatus" : "notset",
            "fullname" : "string",
            "email" : "string",
            "username" : "string",
            "status" : "disabled"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value user_config_get[] User configuration.
value[].username string User login name
value[].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
value[].fullname string User full name
value[].status string Shows whether the user account is enabled or disabled.

Defines status of user accounts Value is one of:
disabled: The user account is disabled.
enabled: The user account is enabled.
value[].passwordstatus string Shows whether the user account is still valid or expired.

Defines state of user password Value is one of:
notset: No password has been set
expired: The password has expired.
valid: The password is still valid.
value[].email string Email address of the local account.

Errors:

HTTP Status Code Type Description
500 error Generic error