| Anchor | ||||
|---|---|---|---|---|
|
...
Each function returns a JSON group object. The group object has these attributes:
| Attributes | Type | Description |
|---|---|---|
| description | String | The description of the group. |
| isFlexDeployAdministrator | Boolean | The boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false. |
| groupId | Long | The unique Id of the group. |
| groupName | String | The unique name of the group. |
| isActive | Boolean | The boolean representing whether the group is active. If isActive is updated to null it will default to true. |
| globalPermissions | List<GlobalPermissionPojo> | The list of global permissions associated with the group |
| deploymentPermissions | List<DeploymentPermissionPojo> | The list of deployment permissions associated with the group |
Additionally, each GlobalPermissionPojo in the list of globalpermissions contains these attributes
...
Additionally, each DeploymenPermissionPojo in the list of deploymentPermissions contains these attributes
| Attributes | Type | Description |
|---|---|---|
| environmentIds | List<Long> | The list of environment Ids associated with the deployment permissions |
| allEnvironments | Boolean | The boolean representing whether the group is able to deploy all environments or not. If allEnvironments is updated to null it will default to false. |
GET
There are two implementations of GET. One will find a group with the given Id and return the JSON representation of the group . The other will find a list of groups matching the parameters supplied to it.
...
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 |
...
...
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} |
...