...

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.

...

Include Page

...

title	Base URL for Group REST API

...

http://host:port/flexdeploy/rest/v1/administration/security/group

	REST V1 Authentication
	REST V1 Authentication

Table of Contents

maxLevel	2

Each function returns a JSON group object. The group object has these attributes:

...

Additionally, each GlobalPermissionPojo in the list of globalpermissions contains these attributes

...

	2

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

AttributesTypeDescriptionenvironmentsList<Long>The list of environment Ids associated with the deployment permissionsallEnvironmentsBooleanThe boolean representing whether the group is able to deploy all environments or not. If allEnvironments is updated to null it will default to false.

, 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.

...

Info

title	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

Include Page

	REST V1 Group Response
	REST V1 Group Response

Example

If we had a group in our database with an Id of 10000 and had the following attributes

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "description": "test",
   "isFlexDeployAdministrator": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environments":    [
      18605,
      20610
   ],
	"allEnvironments":false
}
}

Back to Top

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

title	API URLs

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/topology/administration/security/group?groupName=read

...

Tip
The query parameters are not case sensitive. Searching by groupName=NAME is the same as searching by groupName=name.

...

Request

Attributes	Type	Required	Description
groupName	String	No	The name of the group.

Include Page

	REST V1 Group Response
	REST V1 Group Response

Example

If we had a group in our database with an Id of 10000 and had the following attributes

...

Code Block

theme	Eclipse
title	Group - 10000

[
{
   "description": "test",
   "isFlexDeployAdministrator": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environments":    [
      18605,
      20610
   ],
	"allEnvironments":false
}
}
]

Back to Top

POST

This POST service will create a new group with the same attributes as the given JSON object.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/administration/security/group

...

Request

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 groupgroup

Include Page

	REST V1 Group Response
	REST V1 Group Response

Example

If the POST request receives the following JSON group object,

...

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": {"environments": [],
   "allEnvironments":false
  	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

Back to Top

PUT

This PUT service will update all attributes of a group with the given Id based on the attributes of a JSON object parameters.

Info

title	API URL

http://host:port/flexdeploy/administration/security/group/{Id}

...

Request

Long

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
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

Include Page

	REST V1 Group Response
	REST V1 Group Response

Example

If we had a group in our database with an Id of 10000 and had the following attributes

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "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"
      }
   ]
}

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

title	API URL

http://host:port/flexdeploy/administration/security/group/{Id}

...

Request

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.	groupId	Long	No	The unique Id of the group.
groupName	String	No	The unique name of the group.
isActive	Boolean	No	The boolean representing whether the group is active.
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

Include Page

	REST V1 Group Response
	REST V1 Group Response

Example

If we had a group in our database with an Id of 10000 and had the following attributes

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "description": "This is an patched group.",
   "groupName": "Simple Group Patch",
   "isActive": true,
   "isFlexDeployAdministrator": false,
   "deploymentPermissions": {"environments": [],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...

Versions Compared

Old Version 12

New Version 13

Key

GET

Request

Example

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To search by group name:

Request

Example

POST

Request

PUT

Request

Example

PATCH

Request

Example

Page Comparison

Versions Compared

Old Version 12

New Version 13

Key

GET

Request

Example

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To search by group name:

Request

Example

POST

Request

PUT

Request

Example

PATCH

Request

Example