Anchor

	Top
	Top

...

Attributes	Type	Description
description	String	The description of the group.
isFDAdminisFlexDeployAdministrator	Boolean	The boolean representing whether the group is a Flex Deploy Administrator.
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.
globalPermissions	List<GlobalPermissionPojo>	The list of global permissions associated with the group
deploymentPermissions	List<DeploymentPermissionPojo>	The list of deployment permissions associated with the group

...

Attributes	Type	Description
environmentIds	List<Long>	The list of environment Ids associated with the deployment permissions
deployAllEnvironmentsallEnvironments	Boolean	The boolean representing whether the group is able to deploy all environments or not.

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "description": "test",
   "isFDAdminisFlexDeployAdministrator": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ],
	"deployAllEnvironmentsallEnvironments":false
}
}

When we run a GET request at the following URL

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "description": "test",
   "isFDAdminisFlexDeployAdministrator": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ],
	"deployAllEnvironmentsallEnvironments":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/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",
   "isFDAdminisFlexDeployAdministrator": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ],
	"deployAllEnvironmentsallEnvironments":false
}
}

When we run a GET request at the following URL

...

Code Block

theme	Eclipse
title	Group - 10000

[
{
   "description": "test",
   "isFDAdminisFlexDeployAdministrator": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ],
	"deployAllEnvironmentsallEnvironments":false
}
}
]

Back to Top

...

POST

...

Attributes	Type	Required	Description
description	String	No	The description of the group.
isFDAdminisFlexDeployAdministrator	Boolean	No	The boolean representing whether the group is a Flex Deploy Administrator.
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.
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

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "description": "This is a simple group with no permissions.",
   "groupName": "Simple Group",
   "isActive": true,
   "isFDAdminisFlexDeployAdministrator": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironmentsallEnvironments":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,
   "isFDAdminisFlexDeployAdministrator": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironmentsallEnvironments":false
  	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...

Attributes	Type	Required	Description
description	String	No	The description of the group.
isFDAdminisFlexDeployAdministrator	Boolean	No	The boolean representing whether the group is a Flex Deploy Administrator.
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.
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

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "description": "This is a simple group with no permissions.",
   "groupName": "Simple Group",
   "isActive": true,
   "isFDAdminisFlexDeployAdministrator": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironmentsallEnvironments":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,
   "isFDAdminisFlexDeployAdministrator": false,
   "deploymentPermissions": {"environmentIds": [11001],
   "deployAllEnvironmentsallEnvironments":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,
   "isFDAdminisFlexDeployAdministrator": false,
   "deploymentPermissions": {"environmentIds": [11001],
   "deployAllEnvironmentsallEnvironments":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}

...

Attributes	Type	Required	Description
description	String	No	The description of the group.
isFDAdminisFlexDeployAdministrator	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

...

Code Block

theme	Eclipse
title	Group - 10000

{
   "description": "This is a simple group with no permissions.",
   "groupName": "Simple Group",
   "isActive": true,
   "isFDAdminisFlexDeployAdministrator": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironmentsallEnvironments":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,
   "isFDAdminisFlexDeployAdministrator": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...

Versions Compared

Old Version 4

New Version 5

Key

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:

POST

PATCH

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

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:

POST

PATCH