GetGroup

This method can be used for the following functionality: Get details for a group including projects & members assigned to it.

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

GET /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:

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

cf_key_allowlist (string) (optional)

List of custom field keys to include in response. Add multiple for more than one key e.g. ?cf_key_allowlist=key1&cf_key_allowlist=key2 or specify no keys to exclude all fields e.g. ?cf_key_allowlist=

Example:

GET /api/ss/group/5eab99471e18050942c7607a?cf_key_allowlist=key1&cf_key_allowlist=key2 HTTP/1.1

cf_key_blocklist (string) (optional)

List of custom field keys to exclude from response. Add multiple for more than one key e.g. ?cf_key_blocklist=key1&cf_key_blocklist=key2

Example:

GET /api/ss/group/5eab99471e18050942c7607a?cf_key_blocklist=key1&cf_key_blocklist=key2 HTTP/1.1

Example

The following example is a cURL request to get all details for a group.

Request

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

curl -X GET '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'

Response

Response contains a group object.

{
  "group": {
    "name": "...",
    "id": "...",
    "group_owner": "...",
    "primary_contact_name": "...",
    "primary_contact_number": "...",
    "primary_contact_email": "...",
    "is_deleted": false,
    "created": "...",
    "created_by": "...",
    "last_modified": "...",
    "projects": [
      {
        "name": "...",
        "id": "..."
      }
    ],
    "members": [
      {
        "name": "...",
        "userId": "...",
        "accessLevel": "...",
        "created": "...",
        "last_updated": "..."
      }
    ],
    "custom_fields": [
      {
        "key": "...",
        "value": "..."
      }
    ],
    "access": {
      "member_admins": [
        {
          "add_user_method": "email",
          "allow_user_invite": true,
          "project_limit": "view",
          "project_request_limit": "none",
          "user_id": "668ba6b1be6510000f78f79e"
        }
      ],
      "sso_1": [
        {
          "group_name": "AD-GROUP-1",
          "project_access_level": "edit",
          "project_request_access_level": "action"
        }
      ],
      "sso_2": []
    },
    "auto_add_project_request": true,
    "enable_project_team_notifications": true
  }
}