{
  "opencollection": "1.0.0",
  "info": {
    "name": "VirusTotal API v3 - Access Control Access Control - Group Management Access Control - User Management API",
    "version": "3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-apikey",
      "value": "{{x-apikey}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Access Control - User Management",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VirusTotal Get a User Object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User ID or API key"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint retrieves information about a user, including the privileges and quotas associated to the user. The user can be retrieved either by user ID or by API key, but the former only works if the requester is the user himself or an administrator of a group the user belongs to.\n\nReturns an [User](https://gtidocs.virustotal.com/reference/user-object) object.\n"
        },
        {
          "info": {
            "name": "VirusTotal Update a User Object",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://www.virustotal.com/api/v3/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User ID or API key"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "This request accepts a JSON body containing the user attributes to update. Attributes not present in the request body remain the same. It returns the updated [User](https://gtidocs.virustotal.com/reference/user-object) object.\n"
        },
        {
          "info": {
            "name": "VirusTotal Delete a User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.virustotal.com/api/v3/users/:id",
            "headers": [
              {
                "name": "x-user-password",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User ID or API key"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-apikey",
              "value": "{{x-apikey}}",
              "placement": "header"
            }
          },
          "docs": "This request deletes a given user. A user account can only be deleted by its owner, a 403 error is returned otherwise.\n\nAn additional `x-user-password` header is required, which is used as confirmation.\n"
        },
        {
          "info": {
            "name": "VirusTotal Get Object Descriptors Related to a User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/users/:id/relationships/:relationship",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Username or API key"
              },
              {
                "name": "relationship",
                "value": "",
                "type": "path",
                "description": "Relationship name (see [table](ref:user-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 [/users/{id}/{relationship}](https://gtidocs.virustotal.com/reference/users-relationships) except it returns just the related object's IDs (and context attributes, if any) instead of returning all attributes.\n"
        },
        {
          "info": {
            "name": "VirusTotal Get Objects Related to a User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.virustotal.com/api/v3/users/:id/:relationship",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Username or API key"
              },
              {
                "name": "relationship",
                "value": "",
                "type": "path",
                "description": "Relationship name (see [table](ref:user-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": "Users are related to other objects in our dataset. As mentioned in the [Relationships](https://gtidocs.virustotal.com/reference/relationships) section, those related objects can be retrieved by sending `GET` requests to this API endpoint.\n\nSome relationships are only accessible to their account's owners and their group's admins.\n\nThe supported relationships are documented in the [User](https://gtidocs.virustotal.com/reference/user-object#relationships) API object page.\n"
        }
      ]
    }
  ],
  "bundled": true
}