UpdateGroupRESTfulAPIMethods

Grant a group access to RESTful API methods, or revoke it.

Only an Administrator can call this route, and it cannot be run as another user.

Methods are named by their operationId, e.g. 'getProjects'. Get Available RESTful API Methods lists every name that is accepted, and Get Group RESTful API Methods lists the ones the group has now. A later operation on the same method wins.

The access is held by the group, as on its Other Access page in the application, and every member of the group has it on top of their own. No member is changed or given an API key. A method that a member has been given directly, or by another group, stays available to them after it is removed here.

Headers

PATCH /api/ss/group/:id/methods HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json

Request

Path Parameters

id - string | required

ID of the user. Must be a 24-character hexadecimal id.

Body

operations - list of objects | required

Methods to grant or revoke. At least one operation is required.

• methods - list of strings | required

  • List of method names. At least one is required.

• type - string | required

  • Must be either 'add' or 'remove'

Example

Request

curl --request PATCH \
	--url https://demo.attackforge.com/api/ss/group/5eab99471e18050942c7607a/methods \
	--header 'content-type: application/json' \
	--header 'x-ssapi-key: ************' \
	--data '{
		"operations":[
			{
				"type":"add",
				"methods":[
					"getProjects",
					"getVulnerabilities"
				]
			},
			{
				"type":"remove",
				"methods":[
					"createProject"
				]
			}
		]
	}'

Response

{
  "status": "ok | error",
  "error": "..."
}

Access and failures

Errors are returned in error:

• Unauthorized - the caller is not an Administrator.

• Group Not Found or Error Finding Group - the group could not be found. An archived group is not found.

• Unknown methods: a, b - a method is not one of the RESTful API methods. Nothing is applied.

• Error Granting Methods or Error Revoking Methods - the change could not be saved. Methods are granted before any are revoked, so a revoking error means the grants were applied.