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

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

Query

id (string)

Id of the group.

Example:

PUT /api/ss/group/5eab99471e18050942c7607a HTTP/1.1

name (string) (optional)

Name of the group.

Example:

{
   "name": "..."
}

group_owner (string) (optional)

Name of the owner for the group.

Example:

{
   "group_owner": "..."
}

primary_contact_name (string) (optional)

Primary contact person name.

Example:

{
   "primary_contact_name": "..."
}

primary_contact_number (string) (optional)

Primary contact person number.

Example:

{
   "primary_contact_number": "..."
}

primary_contact_email (string) (optional)

Primary contact person email.

Example:

{
   "primary_contact_email": "..."
}

linked_groups_view (array of strings) (optional)

Active Directory Link - provide VIEW membership to this group via SSO.

Example:

{   
    "linked_groups_view": [ "...", "..." ]
}

linked_groups_upload (array of strings) (optional)

Active Directory Link - provide UPLOAD membership to this group via SSO.

Example:

{   
    "linked_groups_upload": [ "...", "..." ]
}

linked_groups_edit (array of strings) (optional)

Active Directory Link - provide EDIT membership to this group via SSO.

Example:

{   
    "linked_groups_edit": [ "...", "..." ]
}

is_deleted (boolean) (optional)

Whether group is deleted or not.

Example:

{
   "is_deleted": false
}

custom_fields (array of objects) (optional)

Custom fields. Must include a key and value. Key must be unique and letters, number and underscores only.

For more information visit https://support.attackforge.com/attackforge-enterprise/getting-started/custom-fields-and-forms#using-custom-fields-with-apis

Example:

{   
    "custom_fields": [
        {
            "key": "...",
            "value": "..."
        }
    ]
}

Example

The following example is a cURL request to update a group.

Request

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

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 '{
  "name": "ACME Corp. Technology Team",
  "group_owner": "John Citizen",
  "primary_contact_name": "Paul Citizen",
  "primary_contact_number": "[phone]",
  "primary_contact_email": "[email protected]",
  "linked_groups_view": [ 
    "CLIENT_GROUP"
  ],
  "linked_groups_upload": [ 
    "ENGINEERING_GROUP"
  ],
  "linked_groups_edit": [ 
    "PENTESTER_GROUP"
  ],
  "custom_fields": [
      {
          "key": "client_code",
          "value": "CLIENT001"
      }
  ],
  "is_deleted": false
}'

Response

Response contains a status.

{
  "status": "Group Updated",
  "group" : {
      "id" : "61fc6e476cdcfa1b9a56c7f2",
      "created" : "2022-02-04T00:07:35.647Z",
      "last_modified" : "2022-02-04T00:07:35.647Z",
      "name" : "ACME Corp. Digital Team",
      "group_owner" : "John Citizen",
      "primary_contact_email" : "[email protected]",
      "primary_contact_name" : "Paul Citizen",
      "primary_contact_number" : "[phone]",
      "linked_groups_view": [ 
        "CLIENT_GROUP"
      ],
      "linked_groups_upload": [ 
        "ENGINEERING_GROUP"
      ],
      "linked_groups_edit": [ 
        "PENTESTER_GROUP"
      ]
   }
}