/mgmt/config/default/User GET

Use the HTTP GET method with the /mgmt/config/default/User resource to request a list of configured admin users.

Resource URL

https://host:port/mgmt/config/default/User
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes all administrative users of the appliance. Each object contains the following fields:
name
String.
The user name of the administrative user.
mAdminState
String.
The state of the administrative user, can be one of the following values:
  • enabled
  • disabled
UserSummary
String.
Comments added when the user was created.
AccessLevel
String.
The access level of the user, can be one of the following values:
  • privileged
  • group-defined
If the AccessLevel is group-defined then the response also contains the GroupName entry.
GroupName
The user group for the user. It is a reference to an existing group object and is specified as a JSON object.

Examples

The following example requests a list of the administrative users on the appliance.

The following URL is used with the HTTP GET method:
GET /mgmt/config/default/User
The following listing shows the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/config/default/User"
    },
    "doc": {
      "href": "/mgmt/docs/config/User"
    }
  },
  "User": [
    {
      "name": "admin",
      "_links": {
        "self": {
          "href": "/mgmt/config/default/User/admin"
        },
        "doc": {
          "href": "/mgmt/docs/config/User"
        }
      },
      "mAdminState": "enabled",
      "UserSummary": "Administrator",
      "AccessLevel": "privileged"
    },
    {
      "name": "mquser1",
      "_links": {
        "self": {
          "href": "/mgmt/config/default/User/mquser1"
        },
        "doc": {
          "href": "/mgmt/docs/config/User"
        }
      },
      "mAdminState": "enabled",
      "UserSummary": "MQ user 1",
      "AccessLevel": "group-defined",
      "GroupName": {
        "value": "mqusers",
        "href": "/mgmt/config/default/UserGroup/mqusers"
      }
    }