AttackForge Enterprise & AttackForge Core
Powered By GitBook
UpdateGroup
This method can be used for the following functionality: Update an existing 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/:id HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

id (string)
Id of the group.
Example:
1
PUT /api/ss/group/5eab99471e18050942c7607a HTTP/1.1
Copied!
name (string) (optional)
Name of the group.
Example:
1
{
2
"name": "..."
3
}
Copied!
group_owner (string) (optional)
Name of the owner for the group.
Example:
1
{
2
"group_owner": "..."
3
}
Copied!
primary_contact_name (string) (optional)
Primary contact person name.
Example:
1
{
2
"primary_contact_name": "..."
3
}
Copied!
primary_contact_number (string) (optional)
Primary contact person number.
Example:
1
{
2
"primary_contact_number": "..."
3
}
Copied!
primary_contact_email (string) (optional)
Primary contact person email.
Example:
1
{
2
"primary_contact_email": "..."
3
}
Copied!
is_deleted (boolean) (optional)
Whether group is deleted or not.
Example:
1
{
2
"is_deleted": false
3
}
Copied!

Example

The following example is a cURL request to create a new group.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X PUT 'https://demo.attackforge.com/api/ss/group/5eab99471e18050942c7607a' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
2
"name": "ACME Corp. Technology Team",
3
"group_owner": "John Citizen",
4
"primary_contact_name": "Paul Citizen",
5
"primary_contact_number": "(555)555-5555",
6
"primary_contact_email": "[email protected]",
7
"is_deleted": false
8
}'
Copied!

Response

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