{
  "opencollection": "1.0.0",
  "info": {
    "name": "PeerTube Abuses Users API",
    "version": "8.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://peertube2.cpy.re/api/v1/users",
            "params": [
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Plain text search that will match with user usernames or emails"
              },
              {
                "name": "blocked",
                "value": "",
                "type": "query",
                "description": "Filter results down to (un)banned users"
              },
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "Filter results down to users with a specific role"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Offset used to paginate results"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Number of items to return"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort users by criteria"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List users"
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a user"
        },
        {
          "info": {
            "name": "Get a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://peertube2.cpy.re/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              },
              {
                "name": "withStats",
                "value": "",
                "type": "query",
                "description": "include statistics about the user (only available as a moderator/admin)"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a user"
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://peertube2.cpy.re/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update a user"
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://peertube2.cpy.re/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete a user"
        },
        {
          "info": {
            "name": "Block a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/:id/block",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Prevent a user from logging in and interacting with the instance"
        },
        {
          "info": {
            "name": "Unblock a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/:id/unblock",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allow a previously blocked user to login and interact with the instance"
        },
        {
          "info": {
            "name": "Resend user verification link",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/ask-send-verify-email",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Resend user verification link"
        },
        {
          "info": {
            "name": "Verify a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/:id/verify-email",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Following a user registration, the new user will receive an email asking to click a link\ncontaining a secret.\nThis endpoint can also be used to verify a new email set in the user account.\n"
        },
        {
          "info": {
            "name": "Ask to reset password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/ask-reset-password",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "An email containing a reset password link"
        },
        {
          "info": {
            "name": "Reset password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/:id/reset-password",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reset password"
        },
        {
          "info": {
            "name": "Request two factor auth",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/:id/two-factor/request",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Request two factor authentication for a user"
        },
        {
          "info": {
            "name": "Confirm two factor auth",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/:id/two-factor/confirm-request",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Confirm a two factor authentication request"
        },
        {
          "info": {
            "name": "Disable two factor auth",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://peertube2.cpy.re/api/v1/users/:id/two-factor/disable",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Entity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/api/v1/users/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Disable two factor authentication of a user"
        }
      ]
    }
  ],
  "bundled": true
}