Skip to main content

POST /roleGroups

Use this method to create a new role group.

Authentication​

Authentication with username and password is required.

Request URL​

POST https://{management_server_IP}/roleGroups

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
descriptionOptionalStringDescription of the role group
nameRequiredStringName of the role group
rolesRequiredArray of stringsList 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.

usersOptionalArray of stringsList 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​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
resultStringResults 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.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
    "result": "success",
    "messages": [{
        "explanation": "",
        "id": "FQXHMSE0001I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request completed successfully."
    }]
}