{
  "opencollection": "1.0.0",
  "info": {
    "name": "BTCPay Greenfield API Keys Users API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get current user information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/users/me",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "View information about the current user"
        },
        {
          "info": {
            "name": "Update current user information",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{btcpay-host}/api/v1/users/me",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Update the current user"
        },
        {
          "info": {
            "name": "Deletes user profile",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{btcpay-host}/api/v1/users/me",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes user profile and associated user data for user making the request"
        },
        {
          "info": {
            "name": "Uploads a profile picture for the current user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/users/me/picture",
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Uploads a profile picture for the current user"
        },
        {
          "info": {
            "name": "Deletes user profile picture",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{btcpay-host}/api/v1/users/me/picture",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes the user profile picture"
        },
        {
          "info": {
            "name": "Get all users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/users",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Load all users that exist."
        },
        {
          "info": {
            "name": "Create user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a new user.\n\nThis operation can be called without authentication in any of this cases:\n* There is not any administrator yet on the server,\n* User registrations are not disabled in the server's policies.\n\nIf the first administrator is created by this call, user registrations are automatically disabled."
        },
        {
          "info": {
            "name": "Get user by ID or Email",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/users/:idOrEmail",
            "params": [
              {
                "name": "idOrEmail",
                "value": "",
                "type": "path",
                "description": "The user's id or email"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get 1 user by ID or Email."
        },
        {
          "info": {
            "name": "Delete user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{btcpay-host}/api/v1/users/:idOrEmail",
            "params": [
              {
                "name": "idOrEmail",
                "value": "",
                "type": "path",
                "description": "The user's id or email"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete a user.\n\nMust be an admin to perform this operation.\n\nAttempting to delete the only admin user will not succeed.\n\nAll data associated with the user will be deleted as well if the operation succeeds."
        },
        {
          "info": {
            "name": "Toggle user lock out",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/users/:idOrEmail/lock",
            "params": [
              {
                "name": "idOrEmail",
                "value": "",
                "type": "path",
                "description": "The user's id or email"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Lock or unlock a user.\n\nMust be an admin to perform this operation.\n\nAttempting to lock the only admin user will not succeed."
        },
        {
          "info": {
            "name": "Toggle user approval",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/users/:idOrEmail/approve",
            "params": [
              {
                "name": "idOrEmail",
                "value": "",
                "type": "path",
                "description": "The user's id or email"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Approve or unapprove a user.\n\nMust be an admin to perform this operation.\n\nAttempting to (un)approve a user for which this requirement does not exist will not succeed."
        }
      ]
    }
  ],
  "bundled": true
}