{
  "opencollection": "1.0.0",
  "info": {
    "name": "BloodHound AD Base Entities BloodHound Users API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "BloodHound Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/bloodhound-users",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Sortable columns are first_name, last_name, email_address, principal_name, last_login, created_at, updated_at, deleted_at."
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query"
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query"
              },
              {
                "name": "email_address",
                "value": "",
                "type": "query"
              },
              {
                "name": "principal_name",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "query"
              },
              {
                "name": "last_login",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_at",
                "value": "",
                "type": "query",
                "description": "Filter results by `created_at` value. See filter schema details for valid predicates."
              },
              {
                "name": "updated_at",
                "value": "",
                "type": "query",
                "description": "Filter results by `updated_at` value. See filter schema details for valid predicates."
              },
              {
                "name": "deleted_at",
                "value": "",
                "type": "query",
                "description": "Filter results by `deleted_at` value. See filter schema details for valid predicates."
              }
            ]
          },
          "docs": "Gets all BloodHound user details."
        },
        {
          "info": {
            "name": "Create a New User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/bloodhound-users",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new BloodHound user."
        },
        {
          "info": {
            "name": "List Users Minimal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/bloodhound-users-minimal",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Sortable columns are id, first_name, last_name and email_address."
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query"
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query"
              },
              {
                "name": "email_address",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns all BloodHound user details without any sensitive data."
        },
        {
          "info": {
            "name": "Get a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/bloodhound-users/:user_id",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Get a BloodHound user's details."
        },
        {
          "info": {
            "name": "Update a User",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/bloodhound-users/:user_id",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a BloodHound user's properties'."
        },
        {
          "info": {
            "name": "Delete a User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v2/bloodhound-users/:user_id",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Deletes an existing BloodHound user."
        },
        {
          "info": {
            "name": "Create or Set User Secret",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v2/bloodhound-users/:user_id/secret",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or set a user's secret to use as a login password."
        },
        {
          "info": {
            "name": "Expire User Secret",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v2/bloodhound-users/:user_id/secret",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Expire a user's secret to use as a login password."
        },
        {
          "info": {
            "name": "Enrolls user in multi-factor authentication",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/bloodhound-users/:user_id/mfa",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Enrolls user in multi-factor authentication"
        },
        {
          "info": {
            "name": "Unenroll user from multi-factor authentication",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v2/bloodhound-users/:user_id/mfa",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unenrolls user from multi-factor authentication"
        },
        {
          "info": {
            "name": "Returns MFA activation status for a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/bloodhound-users/:user_id/mfa-activation",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Returns multi-factor authentication status for a user"
        },
        {
          "info": {
            "name": "Activates MFA for an enrolled user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/bloodhound-users/:user_id/mfa-activation",
            "headers": [
              {
                "name": "Prefer",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Activates multi-factor authentication for an enrolled user"
        }
      ]
    }
  ],
  "bundled": true
}