PatchGroupMember

This method can be used for the following functionality: Patch 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

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

Body

user_id (string)

Id of the user.

Example:

{
   "user_id": "..."
}

project_access (string)

Default access level to all group projects. Must be one of the following - None, View, Upload, Edit.

Example:

{
   "project_access": "Edit"
}

project_request_access (string)

Default access level to all group project requests. Must be one of the following - None, View, Edit, Action.

Example:

{
   "project_request_access": "View"
}

enable_flow_sharing (boolean)

Whether group member is permitted to share Flows linked to the group.

Example:

{
   "enable_flow_sharing": false
}

enable_action_sharing (boolean)

Whether group member is permitted to share Actions linked to the group.

Example:

{
   "enable_action_sharing": false
}

Example

The following example is a cURL request to patch a user's access to a group.

Request

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

curl -X PATCH 'https://demo.attackforge.com/api/ss/group/6833f782b11edbf506b7c747/member' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "user_id":"66320e0de065b47449e0052c",
  "project_access":"Edit",
  "project_request_access":"View",
  "enable_flow_sharing":false,
  "enable_action_sharing":false
}'

Response

Response contains a status.

{
   "status": "ok"
}