{
  "opencollection": "1.0.0",
  "info": {
    "name": "VirusTotal API v3 - Access Control Access Control - Group Management API",
    "version": "3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-apikey",
      "value": "{{x-apikey}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Access Control - Group Management",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VirusTotal Get a Group Object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "VirusTotal Get a Group Object"
        },
        {
          "info": {
            "name": "VirusTotal Update a Group Object",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://www.virustotal.com/api/v3/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "This request accepts a JSON body containing the group attributes to update. Attributes not present in the request body remain the same. It returns the updated [Group](https://gtidocs.virustotal.com/reference/group-object) object.\n"
        },
        {
          "info": {
            "name": "VirusTotal Get Administrators for a Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/administrators",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group id"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of [User](https://gtidocs.virustotal.com/reference/user-object) objects.\n"
        },
        {
          "info": {
            "name": "VirusTotal Grant Group Admin Permissions to a List of Users",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/administrators",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "Update group administrator list. User emails must be used. If a username is used, a 400 error is returned.\n\nNo admins are removed by using this endpoint. To revoke admin privileges from a certain user, use [DELETE/groups/{id}/relationships/administrators/{user_id}](https://gtidocs.virustotal.com/reference/delete-user-group-administrator).\n"
        },
        {
          "info": {
            "name": "VirusTotal Check if a User is a Group Admin",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/administrators/:user_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group id"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID to check."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "VirusTotal Check if a User is a Group Admin"
        },
        {
          "info": {
            "name": "VirusTotal Revoke Group Admin Permissions from a User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/administrators/:user_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group id"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID to remove."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "VirusTotal Revoke Group Admin Permissions from a User"
        },
        {
          "info": {
            "name": "VirusTotal Get Group Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "VirusTotal Get Group Users"
        },
        {
          "info": {
            "name": "VirusTotal Add Users to a Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "Update the group's user list. User emails must be used, if a username is used a 400 error is returned.\n\nNo users are removed by using this endpoint. To remove group membership from a certain user, use [DELETE/groups/{id}/relationships/users/{user_id}](https://gtidocs.virustotal.com/reference/delete-user-from-group).\n"
        },
        {
          "info": {
            "name": "VirusTotal Check if a User is a Group Member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/users/:user_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID."
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User to check."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "VirusTotal Check if a User is a Group Member"
        },
        {
          "info": {
            "name": "VirusTotal Remove a User from a Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/users/:user_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID."
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User to remove."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "VirusTotal Remove a User from a Group"
        },
        {
          "info": {
            "name": "VirusTotal Get Object Descriptors Related to a Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/groups/:id/relationships/:relationship",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID."
              },
              {
                "name": "relationship",
                "value": "",
                "type": "path",
                "description": "Relationship name (see [table](ref:group-object#relationships))"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of related objects to retrieve"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Continuation cursor"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint is the same as [/groups/{id}/{relationship}](https://gtidocs.virustotal.com/reference/groups-relationships) except it returns just the related object's descriptor (and context attributes, if any) instead of returning all attributes.\n"
        },
        {
          "info": {
            "name": "VirusTotal Get Objects Related to a Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/groups/:id/:relationship",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Group ID."
              },
              {
                "name": "relationship",
                "value": "",
                "type": "path",
                "description": "Relationship name (see [table](ref:group-object#relationships))"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of related objects to retrieve"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Continuation cursor"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "Group objects have relationships to other objects. As mentioned in the  [Relationships](https://gtidocs.virustotal.com/reference/relationships) section, those related objects can be retrieved by sending `GET` requests to the relationship URL. \n\nThe relationships supported by group objects are described in the [Group object section](https://gtidocs.virustotal.com/reference/group-object).\n"
        }
      ]
    }
  ],
  "bundled": true
}