GetGroupRESTfulAPIMethods

Get the RESTful API methods a group has been given access to.

Only an Administrator can call this route. It cannot be run as another user, who is never an Administrator.

This is the access held by the group itself, as set on its Other Access page in the application and changed by Update Group RESTful API Methods. Every member of the group has it, on top of the methods each has been given directly. An archived group gives its members nothing, and cannot be read here.

Each method is returned as it appears in Get Available RESTful API Methods, sorted by name, ignoring case, so the two lists can be compared.

Headers

GET /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.

Example

Request

curl --request GET \
	--url https://demo.attackforge.com/api/ss/group/5eab99471e18050942c7607a/methods \
	--header 'content-type: application/json' \
	--header 'x-ssapi-key: ************'

Response

{
  "count": 999,
  "methods": [
    {
      "name": "getProjects",
      "verb": "GET",
      "uri": "/api/ss/projects",
      "description": "Get all projects"
    }
  ]
}

Access and failures

Errors are returned in error, with a count of 0 and an empty list:

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

• Error Finding Methods - the group's methods could not be read.