CreateGroup

This method can be used for the following functionality: Create a new group in AttackForge

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

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

Query

name (string)

Name of the group.

Example:

{
   "name": "..."
}

group_owner (string)

Name of the owner for the group.

Example:

{
   "group_owner": "..."
}

primary_contact_name (string)

Primary contact person name.

Example:

{
   "primary_contact_name": "..."
}

primary_contact_number (string)

Primary contact person number.

Example:

{
   "primary_contact_number": "..."
}

primary_contact_email (string)

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": [ "...", "..." ]
}

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.

curl -X POST 'https://demo.attackforge.com/api/ss/group' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "name": "ACME Corp. Digital Team",
  "group_owner": "John Citizen",
  "primary_contact_name": "Paul Citizen",
  "primary_contact_number": "(555)555-5555",
  "primary_contact_email": "john.citizen@attackforge.com",
  "linked_groups_view": [
    "CLIENT_GROUP"
  ],
  "linked_groups_upload": [
    "ENGINEERING_GROUP"
  ],
  "linked_groups_edit": [
    "PENTESTER_GROUP"
  ]
}'

Response

Response contains a status and group.

{
   "status" : "Group Created",
   "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" : "john.citizen@attackforge.com",
      "primary_contact_name" : "Paul Citizen",
      "primary_contact_number" : "(555)555-5555",
      "linked_groups_view": [
        "CLIENT_GROUP"
      ],
      "linked_groups_upload": [
        "ENGINEERING_GROUP"
      ],
      "linked_groups_edit": [
        "PENTESTER_GROUP"
      ]
   }
}

Last updated

Check YouTube for more tutorials: https://youtube.com/@attackforge