UpdateProjectAccess

This method can be used for the following functionality: Patch the ACL (Access Control List) on a Project

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

PATCH /api/ss/project/{id}/members HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Path

id (string)

Id of the project.

Example:

PATCH /api/ss/project/5eac95f1e594ea09107e9bb5/members HTTP/1.1

Body

operations (array of objects)

ACL operations to be applied.

• type: must be either 'add', 'update' or 'remove'.

• user_id: User id.

• access_level: mandatory when adding an ACL operation. Must be either 'View', 'Upload' or 'Edit'.

• project_role: must be a project role which is configured in the Administration settings.

• notifications: must be either 'All Emails', 'No Emails', 'New Critical Vulnerability', 'New High Vulnerability', 'New Medium Vulnerability', 'New Low Vulnerability', 'New Info Vulnerability', 'Daily Start/Stop Testing', 'Project Role Updated', 'Project On-Hold/Off-Hold', 'Retest Completed', 'Vulnerability Ready For Retesting', 'Vulnerability Re-Opened', or 'Vulnerability Closed'.

Example:

{
  "operations": [
    {
      "type": "add",
      "user_id": "638fb228640930001c4705ff",
      "access_level": "Edit",
      "project_role": "Pentester",
      "notifications": [
        "All Emails"
      ]
    },
    {
      "type": "update",
      "user_id": "638fb228640930001c4705ff",
      "project_role": "Pentest Lead"
    },
    {
      "type": "remove",
      "user_id": "67aafc1bd5fb39fec060265d"
    }
  ]
}

Example

The following example is a cURL request to update access to a project.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X PATCH 'https://demo.attackforge.com/api/ss/project/5eac95f1e594ea09107e9bb5/members' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "operations": [
    {
      "type": "add",
      "user_id": "638fb228640930001c4705ff",
      "access_level": "Edit",
      "project_role": "Pentester",
      "notifications": [
        "All Emails"
      ]
    },
    {
      "type": "update",
      "user_id": "638fb228640930001c4705ff",
      "project_role": "Pentest Lead"
    },
    {
      "type": "remove",
      "user_id": "67aafc1bd5fb39fec060265d"
    }
  ]
}'

Response

Response contains a status.

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