AttackForge Enterprise

UpdateUserAccessOnProject

This method can be used for the following functionality: Update a users' access 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

PUT /api/ss/project/:project_id/access/:user_id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

project_id (string)

Id of the project.

Example:

PUT /api/ss/project/5e64179c899bb708b55ea48c/access/:user_id HTTP/1.1

user_id (string)

Id of the user.

Example:

PUT /api/ss/project/:project_id/access/5e68a59fbfc6890c16dd2f55 HTTP/1.1

update (string)

Permissions on the project. Must be one of the following: View, Upload, Edit, Delete, Restore. If you select Delete the user will be removed from the project. If you select Restore the user will be restored on the project with prior permissions.

Example:

{
"update": "Edit"
}

Example

The following example is a cURL request to update a users' access to Edit on a project.

Request

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

curl -X PUT 'https://demo.attackforge.com/api/ss/project/5e64179c899bb708b55ea48c/access/5e68a59fbfc6890c16dd2f55' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
"update": "Edit"
}'

Response

Response contains a status.

{
"status": "User Access Updated"
}