| Anchor | ||||
|---|---|---|---|---|
|
...
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/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/topology/administration/security/group?groupname=read |
...
| Attributes | Type | Required | Description |
|---|---|---|---|
| description | String | No | The description of the group. |
| isFlexDeployAdministrator | Boolean | No | The boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is set to null it will default to false. |
| groupId | Long | No | The unique Id of the group. |
| groupName | String | Yes | The unique name of the group. |
| isActive | Boolean | No | The boolean representing whether the group is active. If isActive is set to null it will default to true. |
| globalPermissions | List<GlobalPermissionPojo> | No | The list of global permissions associated with the group |
| deploymentPermissions | List<DeploymentPermissionPojo> | No | The list of deployment permissions associated with the group |
...
| Attributes | Type | Required | Description |
|---|---|---|---|
| description | String | No | The description of the group. |
| isFlexDeployAdministrator | Boolean | No | The boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false. |
| groupId | Long | No | The unique Id of the group. |
| groupName | String | Yes | The unique name of the group. |
| isActive | Boolean | No | The boolean representing whether the group is active. If isActive is updated to null it will default to true. |
| globalPermissions | List<GlobalPermissionPojo> | No | The list of global permissions associated with the group |
| deploymentPermissions | List<DeploymentPermissionPojo> | No | The list of deployment permissions associated with the group |
...
...
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/administration/security/group/{Id} |
...