Groups can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of groups.
...
GET (Using Query Parameters)
This GET service will return a list of groups in the form of JSON objects based on the query parameters group name. Groups are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of groups.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/administration/security/group? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:groupName={groupname} Examples:To search by group name:http://host:port/flexdeploy/rest/v1/administration/security/group?groupName=read |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "This is an updated group.",
"groupName": "Simple Group Put",
"isActive": true,
"isAdminGroup": false,
"allEnvironments":false
}
} |
PATCH
This PATCH service will update an existing group with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the group.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/administration/security/group/{Id} |
...
| Attributes | Type | Required | Description |
|---|---|---|---|
| description | String | No | The description of the group. |
isAdminGroup | Boolean | No | The boolean representing whether the group is a Flex Deploy Administrator. |
| groupName | String | No | The unique name of the group. |
| isActive | Boolean | No | The boolean representing whether the group is active. |
...