...
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 |
Additionally, each DeploymenPermissionPojo in the list of deploymentPermissions contains these attributes
| Attributes | Type | Description |
|---|
| environmentIdsenvironments | 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. |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "test",
"isFlexDeployAdministrator": false,
"groupId": 10000,
"groupName": "test",
"isActive": true,
"globalPermissions": [ {
"objectType": "WORKFLOW",
"actionType": "READ"
}],
"deploymentPermissions": {"environmentIdsenvironments": [
18605,
20610
],
"allEnvironments":false
}
} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "test",
"isFlexDeployAdministrator": false,
"groupId": 10000,
"groupName": "test",
"isActive": true,
"globalPermissions": [ {
"objectType": "WORKFLOW",
"actionType": "READ"
}],
"deploymentPermissions": {"environmentIdsenvironments": [
18605,
20610
],
"allEnvironments":false
}
} |
...
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 |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "test",
"isFlexDeployAdministrator": false,
"groupId": 10000,
"groupName": "test",
"isActive": true,
"globalPermissions": [ {
"objectType": "WORKFLOW",
"actionType": "READ"
}],
"deploymentPermissions": {"environmentIdsenvironments": [
18605,
20610
],
"allEnvironments":false
}
} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
[
{
"description": "test",
"isFlexDeployAdministrator": false,
"groupId": 10000,
"groupName": "test",
"isActive": true,
"globalPermissions": [ {
"objectType": "WORKFLOW",
"actionType": "READ"
}],
"deploymentPermissions": {"environmentIdsenvironments": [
18605,
20610
],
"allEnvironments":false
}
}
] |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "This is a simple group with no permissions.",
"groupName": "Simple Group",
"isActive": true,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environmentIdsenvironments": [],
"allEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
},
{
"actionType": "READ",
"objectType": "SCHEDULEDTASK"
},
{
"actionType": "READ",
"objectType": "WORKFLOW"
}
]
} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "This is a simple group with permissions.",
"groupId": 10000,
"groupName": "Simple Group",
"isActive": true,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environmentIdsenvironments": [],
"allEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
},
{
"actionType": "READ",
"objectType": "SCHEDULEDTASK"
},
{
"actionType": "READ",
"objectType": "WORKFLOW"
}
]
} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "This is a simple group with no permissions.",
"groupName": "Simple Group",
"isActive": true,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environmentIdsenvironments": [],
"allEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
},
{
"actionType": "READ",
"objectType": "SCHEDULEDTASK"
},
{
"actionType": "READ",
"objectType": "WORKFLOW"
}
]
} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Environment PUT Receive JSON |
|---|
|
{
"description": "This is an updated group.",
"groupName": "Simple Group Put",
"isActive": true,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environmentIdsenvironments": [11001],
"allEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
}
]
} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "This is an updated group.",
"groupName": "Simple Group Put",
"isActive": true,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environmentIdsenvironments": [11001],
"allEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
}
]
} |
...
Back to Top
...
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} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "This is a simple group with no permissions.",
"groupName": "Simple Group",
"isActive": true,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environmentIdsenvironments": [],
"allEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
},
{
"actionType": "READ",
"objectType": "SCHEDULEDTASK"
},
{
"actionType": "READ",
"objectType": "WORKFLOW"
}
]
} |
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Group - 10000 |
|---|
|
{
"description": "This is an patched group.",
"groupName": "Simple Group Patch",
"isActive": true,
"isFlexDeployAdministrator": false,
"deploymentPermissions": {"environmentIdsenvironments": [],
"deployAllEnvironments":false
},
"globalPermissions": [
{
"actionType": "UPDATE",
"objectType": "APPROVAL"
},
{
"actionType": "READ",
"objectType": "NOTIFICATION"
},
{
"actionType": "READ",
"objectType": "SCHEDULEDTASK"
},
{
"actionType": "READ",
"objectType": "WORKFLOW"
}
]
} |
...