| Anchor | ||||
|---|---|---|---|---|
|
...
Below is the list of possible global permissions
| Object Type | Action Type |
|---|---|
| PROJECT | PAGEVIEW |
| APPROVAL | READ, UPDATE |
| WINDOW | READ, UPDATE |
| NOTIFICATION | READ, UPDATE, DELETE |
| WORKFLOW | READ, UPDATE |
| REPORT | READ |
| ENVINSTANCE | READ, UPDATE |
| ENVIRONMENT | READ, UPDATE |
| INSTANCE | READ, UPDATE |
| ENDPOINT | READ, UPDATE |
| SCHEDULEDTASK | READ, UPDATE |
| PLUGIN | READ, UPLOAD |
| PROPERTYSET | READ |
| DEFAULTS | READ, UPDATE |
| FLEXFIELDS | READ, UPDATE |
| TEMPLATE | READ, UPDATE |
| USER | READ |
| GROUP | READ |
| TESTTOOL | READ, UPDATE |
| TESTTYPE | READ, UPDATE |
| ISSUETRACKINGSYSTEM | READ, UPDATE |
| CHANGEMANAGEMENTSYSTEM | READ, UPDATE |
| RELEASE | READ, UPDATE, CREATESNAPSHOT, CONFIGUREPROJECTLIST, CONFIGUREPIPLINE, CONFIGURECMS, MANAGELIFECYCLE, GRANTPERMISSIONS |
| PIPELINE | READ, UPDATE |
...
This GET service will find a group with the given Id and return the JSON representation of the object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/administration/security/group/{Id} |
Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
Id | URL | Yes | This is a URL parameter for the Id which is used to find and return a group |
...
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/administration/security/group/10000
The GET request would return the following JSON group object
...
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=readread |
* searching by group name returns all groups that contain the specified string in their group name
...
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/administration/security/group?groupname=test
The GET request would return the following JSON group object
...
This POST service will create a new group with the same attributes as the given JSON object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/administration/security/group |
Parameters
| 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 |
...
This PUT service will update all attributes of a group with the given Id based on the attributes of a JSON object parameters.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/administration/security/group/{Id} |
Parameters
| 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 |
...
When we run a PUT request at the following URL
http://host:port/flexdeploy/administration/security/group/10000
And the PUT request receives the following JSON group object,
...
...
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} |
...
When we run a PATCH request at the following URL
http://host:port/flexdeploy/administration/security/group/10000
And the PATCH request receives the following JSON group object,
...