/mgmt/config/default/UserGroup GET

Use the HTTP GET method with the /mgmt/config/default/UserGroup resource to request a list of configured user groups.

Resource URL

https://host:port/mgmt/config/default/UserGroup
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 user groups on the appliance. Each object contains the following fields:
name
String.
The user name of the user group.
mAdminState
String.
The state of the user group, can be one of the following values:
  • enabled
  • disabled
UserSummary
String.
An optional comment for the user group, such as a description of the group.
AccessPolicies
String.
The access level that members of the user group have. For more details about access policies, see Access policies. A single policy is returned as a string. If the user group has multiple access policies, these are returned in a JSON structure.

Examples

The following example requests a list of the user groups on the appliance.

The following URL is used with the HTTP GET method:
GET /mgmt/config/default/UserGroup
The following listing shows the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/config/default/UserGroup"
     }, 
     "doc": {
       "href": "/mgmt/docs/config/UserGroup"
     }
   }, 
   "UserGroup": [
     {
       "name": "MQUser1", 
       "_links": {
        "self": {
          "href": "/mgmt/config/default/UserGroup/MQUser1"
        },
        "doc": {
          "href": "/mgmt/docs/config/UserGroup"
         }
        }, 
        "mAdminState": "enabled", 
        "UserSummary": "creating groups to use for REST doc examples", 
        "AccessPolicies": "*/*/*?Access=r+w+a+d"
       }, 
       {
       "name": "MQUser2", 
       "_links": {
        "self": {
          "href": "/mgmt/config/default/UserGroup/MQUser2"
        },
        "doc": {
          "href": "/mgmt/docs/config/UserGroup"
         }
        }, 
        "mAdminState": "enabled", 
        "UserSummary": "creating groups to use for REST doc examples", 
        "AccessPolicies": ["*/*/*?Access=r+w+a+d+x", "*/*/mgmt/rest-mgmt?Access=NONE"]
       },
     ]
}