Group API
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.
Authentication - Use Basic Authentication for this API.
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 |
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 by ID
This GET service will find a group with the given Id and return the JSON representation of the object.
API URL
http://host:port/flexdeploy/rest/v1/administration/security/group/{Id}
Request
Parameter | Type | Required | Description |
|---|---|---|---|
Id | URL | Yes | This is a URL parameter for the Id which is used to find and return a group |
Response
| 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<GlobalPermission> | The list of global permissions associated with the group |
| deploymentPermissions | List<DeploymentPermission> | The list of deployment permissions associated with the group |
Each GlobalPermission in the list of globalpermissions contains these attributes.
| Attributes | Type | Description |
|---|---|---|
| objectType | String | The object type of the global permission |
| actionType | String | The action type of the global permission |
Each DeploymenPermission in the list of deploymentPermissions contains these attributes.
| Attributes | Type | Description |
|---|---|---|
| environments | 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. |
Example
If we had a group in our database with an Id of 10000 and had the following attributes
Group - 10000
{
"description": "test",
"isFlexDeployAdministrator": false,
"groupId": 10000,
"groupName": "test",
"isActive": true,
"globalPermissions": [ {
"objectType": "WORKFLOW",
"actionType": "READ"
}],
"deploymentPermissions": {"environments": [
18605,
20610
],
"allEnvironments":false
}
}When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/administration/security/group/10000
- style