POST /roleGroups

Use the POST method to create a new role group.

Authentication

Authentication with user name and password is required.

Request URL

POST https://<management_server_IP>/roleGroups

Query parameters

None

Request body

Attributes Required / Optional Type Description
description Optional String Description of the role group
name Required String Name of the role group
roles Required Array of strings List of the roles that are included in the role group. To obtain a list of all predefined and custom role names, use the GET /roles method.

For information about the predefined and reserved roles, see Creating a custom role.

users Optional Array of strings List of user IDs that are a members of the role group

Request example

{
   "name": "test-group",
   "description": "description",
   "roles": ["lxc-hw-admin", "lxc-fw-admin"],
   "users": ["USER1", "USER2", "USER3"]
}

Response codes

Code Description
200 OK. The request completed successfully.
400 Bad request. An argument is missing or not valid. a descriptive error message will be returned in the body.
500 Internal server error. A descriptive error message will be returned in the body.

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
    "result": "success",
    "messages": [{
        "explanation": "",
        "id": "FQXHMSE0001I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request completed successfully."
    }]
}