Group REST Reference

/group

Methods
GET

Gets the list of Groups

NOTE: Only viewable shared objects will be returned. If a group retrieved contains to object shares the session user does not have permissions to view, the shares will not be returned.

Fields Parameter
 Expand

NOTE: Currently, all fields come back on GET all, but the ** indicates fields which will be listed in a future release

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
createdTime
modifiedTime
lces
repositories
definingAssets
userCount
users

 Session User has ShareObjects Permission
assets
policies
queries
credentials
dashboardTabs
arcs
auditFiles

Legend

* = always comes back

** = comes back if fields list not specified on GET all
Request Parameters

None

Example Response
 Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "0",
			"name" : "Full Access",
			"description" : "Full Access group"
		},
		{
			"id" : "2",
			"name" : "Group A",
			"description" : ""
		},
		{
			"id" : "3",
			"name" : "Group B",
			"description" : ""
		},
		{
			"id" : "4",
			"name" : "grunt",
			"description" : ""
		},
		{
			"id" : "5",
			"name" : "Full Access Group 2",
			"description" : ""
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1445894598
}

POST

Adds an Group

Note: Cannot add definingAssets of type "watchlist" | "combination" in group definitions

Request Parameters
 Expand
{
	"name" : <string>,
	"description" : <string> DEFAULT "",
	"repositories" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"lces" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"definingAssets" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"assets" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"policies" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"queries" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"credentials" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"dashboardTabs" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"arcs" : [
		{
			"id" : <number>
		}...
	] OPTIONAL,
	"auditFiles" : [
		{
			"id" : <number>
		}...
	] OPTIONAL
}
Example Response
 Expand
{
	"type" : "regular",
	"response" : {
		"id" : "5",
		"name" : "Full Access Group test",
		"description" : "",
		"createdTime" : "1436551970",
		"modifiedTime" : "1445892755",
		"lces" : [
			{
				"id" : "3",
				"name" : "test LCE",
				"description" : "Copied from Box for testing",
				"version" : "4.6.0"
			},
			{
				"id" : "4",
				"name" : "LCE 1",
				"description" : "Copied from Box for testing",
				"version" : "4.4.1"
			},
			{
				"id" : "5",
				"name" : "LCE 2",
				"description" : "Copied from Box for testing",
				"version" : "4.4.0"
			}
		],
		"repositories" : [
			{
				"id" : "38",
				"name" : "ipv4",
				"description" : "copied from QA",
				"lastVulnUpdate" : "1445621650",
				"type" : "Local",
				"dataFormat" : "IPv4"
			},
			{
				"id" : "39",
				"name" : "ipv6 rep",
				"description" : "Copied from QA 2",
				"lastVulnUpdate" : "1437805904",
				"type" : "Local",
				"dataFormat" : "IPv6"
			},
			{
				"id" : "44",
				"name" : "Test w/pluginPrefs",
				"description" : "",
				"lastVulnUpdate" : "0",
				"type" : "Local",
				"dataFormat" : "mobile"
			},
			{
				"id" : "57",
				"name" : "test mobile airwatch rep",
				"description" : "",
				"lastVulnUpdate" : "0",
				"type" : "Local",
				"dataFormat" : "mobile"
			}
		],
		"definingAssets" : [
			{
				"id" : "0",
				"name" : "All Defined Assets",
				"description" : "All defining ranges of the Group in whose context this Asset is being evaluated."
			},
			{
				"id" : "0",
				"name" : "All Defined Ranges",
				"description" : ""
			}
		],
		"userCount" : 0,
		"users" : [],
		"assets" : [],
		"policies" : [],
		"queries" : [],
		"credentials" : [],
		"dashboardTabs" : [],
		"auditFiles" : [],
		"arcs" : [
			{
				"id" : "18",
				"name" : "Database Settings",
				"description" : "The Database ARC presents a series of policy statements that measure percentage compliance against organizational policies such as authentication policy, privilege policy, and best practices. These policies all share a common theme in assessing database compliance and configuration.	Organizational policy should in turn be based on appropriate currently accepted standards.	\n\nThe ARC and the associated policy statements rely on audit results received from Nessus scans utilizing database audit files for compliance scanning. The audit files and policy statements are guides that can be customized to fit the specific policy guidelines of the organization.\n\nBy reviewing the ARC, Compliance Managers can easily and quickly identify compliance concerns within database-driven systems based around these controls, and rapidly identify gaps in the database security programs or policies."
			}
		]
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1445892755
}

/group/{id}

Methods
GET

Gets the Group associated with {id}.

NOTE: Only viewable shared objects will be returned. If the group retrieved contains to object shares the session user does not have permissions to view, the shares will not be returned.

Fields Parameter
 Expand

NOTE: Currently, all fields come back on GET all, but the ** indicates fields which will be listed in a future release

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
createdTime
modifiedTime
lces
repositories
definingAssets
userCount
users

Session User has ShareObjects Permission
assets
policies
queries
credentials
dashboardTabs
arcs
auditFiles

Legend

* = always comes back

** = comes back if fields list not specified on GET all
Request Parameters

None

Example Response
 Expand
{
	"type" : "regular",
	"response" : {
		"id" : "5",
		"name" : "Full Access Group test",
		"description" : "",
		"createdTime" : "1436551970",
		"modifiedTime" : "1445892755",
		"lces" : [
			{
				"id" : "3",
				"name" : "test LCE",
				"description" : "Copied from Box for testing",
				"version" : "4.6.0"
			},
			{
				"id" : "4",
				"name" : "LCE 1",
				"description" : "Copied from Box for testing",
				"version" : "4.4.1"
			},
			{
				"id" : "5",
				"name" : "LCE 2",
				"description" : "Copied from Box for testing",
				"version" : "4.4.0"
			}
		],
		"repositories" : [
			{
				"id" : "38",
				"name" : "ipv4",
				"description" : "copied from QA",
				"lastVulnUpdate" : "1445621650",
				"type" : "Local",
				"dataFormat" : "IPv4"
			},
			{
				"id" : "39",
				"name" : "ipv6 rep",
				"description" : "Copied from QA 2",
				"lastVulnUpdate" : "1437805904",
				"type" : "Local",
				"dataFormat" : "IPv6"
			},
			{
				"id" : "44",
				"name" : "Test w/pluginPrefs",
				"description" : "",
				"lastVulnUpdate" : "0",
				"type" : "Local",
				"dataFormat" : "mobile"
			},
			{
				"id" : "57",
				"name" : "test mobile airwatch rep",
				"description" : "",
				"lastVulnUpdate" : "0",
				"type" : "Local",
				"dataFormat" : "mobile"
			}
		],
		"definingAssets" : [
			{
				"id" : "0",
				"name" : "All Defined Assets",
				"description" : "All defining ranges of the Group in whose context this Asset is being evaluated."
			},
			{
				"id" : "0",
				"name" : "All Defined Ranges",
				"description" : ""
			}
		],
		"userCount" : 0,
		"users" : [],
		"assets" : [],
		"policies" : [],
		"queries" : [],
		"credentials" : [],
		"dashboardTabs" : [],
		"auditFiles" : [],
		"arcs" : [
			{
				"id" : "18",
				"name" : "Database Settings",
				"description" : "The Database ARC presents a series of policy statements that measure percentage compliance against organizational policies such as authentication policy, privilege policy, and best practices. These policies all share a common theme in assessing database compliance and configuration.	Organizational policy should in turn be based on appropriate currently accepted standards.	\n\nThe ARC and the associated policy statements rely on audit results received from Nessus scans utilizing database audit files for compliance scanning. The audit files and policy statements are guides that can be customized to fit the specific policy guidelines of the organization.\n\nBy reviewing the ARC, Compliance Managers can easily and quickly identify compliance concerns within database-driven systems based around these controls, and rapidly identify gaps in the database security programs or policies."
			}
		]
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1445892755
}

PATCH

Edits the Group associated with {id}, changing only the passed in fields.

Request Parameters

(All fields are optional)

Example Response

DELETE

Deletes the Group associated with {id}, depending on access and permissions.

Request Parameters

None

Example Response
 Expand
{
	"type" : "regular",
	"response" : "",
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1408726272
}