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/group/user/:user_id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

group_id (string)

Id of the group.

Example:

{
   "group_id": "..."
}

user_id (string)

Id of the user.

Example:

{
   "user_id": "..."
}

access_level (string)

Default access level to all group projects. Must be one of the following: View, Upload, Edit, Delete. If you select Delete the user will be removed from the group and all group projects.

Example:

{
   "access_level": "Edit"
}

Example

The following example is a cURL request to update a users' access to Edit for all group projects.

Request

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

curl -X PUT 'https://demo.attackforge.com/api/ss/group/user/5e68a59fbfc6890c16dd2f55' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "group_id": "5eab99471e18050942c7607a",
  "user_id": "5e68a59fbfc6890c16dd2f55",
  "access_level": "Edit"
}'

Response

Response contains a status.

{
   "status": "User Access Updated On Group"
}