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 TypeAction Type
PROJECTPAGEVIEW
APPROVALREAD, UPDATE
WINDOWREAD, UPDATE
NOTIFICATIONREAD, UPDATE, DELETE
WORKFLOWREAD, UPDATE
REPORTREAD
ENVINSTANCEREAD, UPDATE
ENVIRONMENTREAD, UPDATE
INSTANCEREAD, UPDATE
ENDPOINTREAD, UPDATE
SCHEDULEDTASKREAD, UPDATE
PLUGINREAD, UPLOAD
PROPERTYSETREAD
DEFAULTSREAD, UPDATE
FLEXFIELDSREAD, UPDATE
TEMPLATEREAD, UPDATE
USERREAD
GROUPREAD
TESTTOOLREAD, UPDATE
TESTTYPEREAD, UPDATE
ISSUETRACKINGSYSTEMREAD, UPDATE
CHANGEMANAGEMENTSYSTEMREAD, UPDATE
RELEASEREAD, UPDATE, CREATESNAPSHOT, CONFIGUREPROJECTLIST, CONFIGUREPIPLINE, CONFIGURECMS, MANAGELIFECYCLE, GRANTPERMISSIONS
PIPELINEREAD, 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

URLYesThis is a URL parameter for the Id which is used to find and return a group

Response

AttributesTypeDescription
descriptionStringThe description of the group.
isFlexDeployAdministratorBooleanThe boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false.
groupIdLongThe unique Id of the group.
groupNameStringThe unique name of the group.
isActiveBooleanThe boolean representing whether the group is active. If isActive is updated to null it will default to true.
globalPermissionsList<GlobalPermission>The list of global permissions associated with the group
deploymentPermissionsList<DeploymentPermission>The list of deployment permissions associated with the group

Each GlobalPermission in the list of globalpermissions contains these attributes.

AttributesTypeDescription
objectTypeStringThe object type of the global permission
actionTypeStringThe action type of the global permission

Each DeploymenPermission in the list of deploymentPermissions contains these attributes.

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

Response Codes

HTTP CodeDescription
200Group was found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Group not found
500Unexpected internal server error

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

The GET request would return the following JSON group object

Group - 10000
{
   "description": "test",
   "isFlexDeployAdministrator": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environments":    [
      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.

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

* searching by group name returns all groups that contain the specified string in their group name

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

Request

AttributesTypeRequiredDescription
groupNameQuery - StringNo

The name of the group.

Contains ignore case type search.

Response

AttributesTypeDescription
descriptionStringThe description of the group.
isFlexDeployAdministratorBooleanThe boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false.
groupIdLongThe unique Id of the group.
groupNameStringThe unique name of the group.
isActiveBooleanThe boolean representing whether the group is active. If isActive is updated to null it will default to true.
globalPermissionsList<GlobalPermission>The list of global permissions associated with the group
deploymentPermissionsList<DeploymentPermission>The list of deployment permissions associated with the group

Each GlobalPermission in the list of globalpermissions contains these attributes.

AttributesTypeDescription
objectTypeStringThe object type of the global permission
actionTypeStringThe action type of the global permission

Each DeploymenPermission in the list of deploymentPermissions contains these attributes.

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

Response Codes

HTTP CodeDescription
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

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?groupname=test

The GET request would return the  following JSON group object

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

POST

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

API URL

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

Request

AttributesTypeRequiredDescription
descriptionStringNoThe description of the group.
isFlexDeployAdministratorBooleanNoThe boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is set to null it will default to false.
groupNameStringYesThe unique name of the group.
isActiveBooleanNoThe boolean representing whether the group is active. If isActive is set to null it will default to true.
globalPermissionsList<GlobalPermissionPojo>No

The list of global permissions associated with the group. If permission is not provided in input, it will be set to false. For example, actionType (READ), objectType (USER) is not present in input, it will be marked as false for this group.

GlobalPermissionPojo contains actionType and objectType attributes.

deploymentPermissionsList<DeploymentPermissionPojo>No

The list of deployment permissions associated with the group. It can be set to

  • all environments
    • allEnvironments: true, environments: []
  • specific environments
    • allEnvironments: false, environments: [1, 2, 3]
  • no environments.
    • allEnvironments: false, environments: []

DeploymentPermissionPojo contains allEnvironment (boolean) and environments (array of environment ids).

Response

AttributesTypeDescription
descriptionStringThe description of the group.
isFlexDeployAdministratorBooleanThe boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false.
groupIdLongThe unique Id of the group.
groupNameStringThe unique name of the group.
isActiveBooleanThe boolean representing whether the group is active. If isActive is updated to null it will default to true.
globalPermissionsList<GlobalPermission>The list of global permissions associated with the group
deploymentPermissionsList<DeploymentPermission>The list of deployment permissions associated with the group

Each GlobalPermission in the list of globalpermissions contains these attributes.

AttributesTypeDescription
objectTypeStringThe object type of the global permission
actionTypeStringThe action type of the global permission

Each DeploymenPermission in the list of deploymentPermissions contains these attributes.

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

Response Codes

HTTP CodeDescription
201Group was created
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If the POST request receives the following JSON group object,

Group - 10000
{
   "description": "This is a simple group with no permissions.",
   "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"
      }
   ]
}

The following group object will then be created as a new row in the database.

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

PUT

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

API URL

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

Request

AttributesTypeRequiredDescription
descriptionStringNoThe description of the group.
isFlexDeployAdministratorBooleanNoThe boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false.
groupNameStringYesThe unique name of the group.
isActiveBooleanNoThe boolean representing whether the group is active. If isActive is updated to null it will default to true.
globalPermissionsList<GlobalPermissionPojo>No

The list of global permissions associated with the group. If permission is not provided in input, it will be set to false. For example, actionType (READ), objectType (USER) is not present in input, it will be marked as false for this group.

GlobalPermissionPojo contains actionType and objectType attributes.

deploymentPermissionsList<DeploymentPermissionPojo>No

The list of deployment permissions associated with the group. It can be set to

  • all environments
    • allEnvironments: true, environments: []
  • specific environments
    • allEnvironments: false, environments: [1, 2, 3]
  • no environments.
    • allEnvironments: false, environments: []

DeploymentPermissionPojo contains allEnvironment (boolean) and environments (array of environment ids).

Response

AttributesTypeDescription
descriptionStringThe description of the group.
isFlexDeployAdministratorBooleanThe boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false.
groupIdLongThe unique Id of the group.
groupNameStringThe unique name of the group.
isActiveBooleanThe boolean representing whether the group is active. If isActive is updated to null it will default to true.
globalPermissionsList<GlobalPermission>The list of global permissions associated with the group
deploymentPermissionsList<DeploymentPermission>The list of deployment permissions associated with the group

Each GlobalPermission in the list of globalpermissions contains these attributes.

AttributesTypeDescription
objectTypeStringThe object type of the global permission
actionTypeStringThe action type of the global permission

Each DeploymenPermission in the list of deploymentPermissions contains these attributes.

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

Response Codes

HTTP CodeDescription
200Group was found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Group not found
500Unexpected internal server error

Example

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

Group - 10000
{
   "description": "This is a simple group with no permissions.",
   "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"
      }
   ]
}

When we run a PUT request at the following URL

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

And the PUT request receives the following JSON group object,

Environment PUT Receive JSON
{
   "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"
      }
   ]
}

The PUT request would then update the group with Id 10000 and return the  following JSON group object

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

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.

API URL

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

Request

AttributesTypeRequiredDescription
descriptionStringNoThe description of the group.
isFlexDeployAdministratorBooleanNoThe boolean representing whether the group is a Flex Deploy Administrator.
groupNameStringNoThe unique name of the group.
isActiveBooleanNoThe boolean representing whether the group is active.
globalPermissionsList<GlobalPermissionPojo>NoThe list of global permissions associated with the group. Existing permissions are not changed, input permissions are marked as true.
deploymentPermissionsList<DeploymentPermissionPojo>No

The list of deployment permissions associated with the group. If using environments array, environment ids are added to existing deployment environments for group.

DeploymentPermissionPojo contains allEnvironment (boolean) and environments (array of environment ids).

Response

AttributesTypeDescription
descriptionStringThe description of the group.
isFlexDeployAdministratorBooleanThe boolean representing whether the group is a Flex Deploy Administrator. If isFlexDeployAdministrator is updated to null it will default to false.
groupIdLongThe unique Id of the group.
groupNameStringThe unique name of the group.
isActiveBooleanThe boolean representing whether the group is active. If isActive is updated to null it will default to true.
globalPermissionsList<GlobalPermission>The list of global permissions associated with the group
deploymentPermissionsList<DeploymentPermission>The list of deployment permissions associated with the group

Each GlobalPermission in the list of globalpermissions contains these attributes.

AttributesTypeDescription
objectTypeStringThe object type of the global permission
actionTypeStringThe action type of the global permission

Each DeploymenPermission in the list of deploymentPermissions contains these attributes.

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

Response Codes

HTTP CodeDescription
200Group was found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Group not found
500Unexpected internal server error

Example

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

Group - 10000
{
   "description": "This is a simple group with no permissions.",
   "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"
      }
   ]
}

When we run a PATCH request at the following URL

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

And the PATCH request receives the following JSON group object,

Group - 10000
{
   "description": "This is an patched group.",
   "groupName": "Simple Group Patch",
   "isActive": null
}

The PATCH request would then update the group with Id 10000 and return the following JSON group object

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