AttackForge Enterprise & AttackForge Core
Powered By GitBook
UpdateUserAccessOnGroup
This method can be used for the following functionality: Update a user's access on a group.

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

1
PUT /api/ss/group/user/:user_id HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

group_id (string)
Id of the group.
Example:
1
{
2
"group_id": "..."
3
}
Copied!
user_id (string)
Id of the user.
Example:
1
{
2
"user_id": "..."
3
}
Copied!
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:
1
{
2
"access_level": "Edit"
3
}
Copied!

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.
1
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 '{
2
"group_id": "5eab99471e18050942c7607a",
3
"user_id": "5e68a59fbfc6890c16dd2f55",
4
"access_level": "Edit"
5
}'
Copied!

Response

Response contains a status.
1
{
2
"status": "User Access Updated On Group"
3
}
Copied!
Last modified 1yr ago