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.
...
| 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 |
| OBJECTTYPE | READ, UPDATE |
| CLOUDACCOUNT | READ, UPDATE |
| ARTIFACTREPOACCOUNT | READ, UPDATE |
| CISERVERACCOUNT | READ, UPDATE |
| ANALYSISTOOLACCOUNT | READ, UPDATE |
| OTHERTOOLSACCOUNT | READ, UPDATE |
| ACCOUNTPROVIDER | READ, UPDATE |
| REALM | READ |
| CREDENTIAL | READ, UPDATE, DELETE |
| CREDENTIALSTORE | READ |
| CREDENTIALSTOREPROVIDER | READ |
| WEBHOOKFUNCTION | READ, UPDATE, DELETE |
| WEBHOOKPROVIDER | READ, UPDATE |
| WEBHOOKMESSAGE | READ, VIEWLOGS, VIEWCONTENT, EXECUTE |
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/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,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environments": [11001],
"allEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
}
]
} |
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} |
...