{
  "opencollection": "1.0.0",
  "info": {
    "name": "Baserow API spec Admin User API",
    "version": "2.2.2"
  },
  "items": [
    {
      "info": {
        "name": "User",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "create_user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new user based on the provided values. If desired an authentication JWT can be generated right away. After creating an account the initial workspace containing a database is created."
        },
        {
          "info": {
            "name": "update_account",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/user/account/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates the account information of the authenticated user."
        },
        {
          "info": {
            "name": "change_email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/change-email/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the email address of a user if the confirmation token is valid. The **send_change_email_confirmation** endpoint sends an email to the new address containing the token. That token can be used to change the email address here."
        },
        {
          "info": {
            "name": "change_password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/change-password/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Changes the password of an authenticated user, but only if the old password matches."
        },
        {
          "info": {
            "name": "dashboard",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/user/dashboard/",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Lists all the relevant user information that for example could be shown on a dashboard. It will contain all the pending workspace invitations for that user."
        },
        {
          "info": {
            "name": "redo",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/user/redo/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Redoes the latest redoable action performed by the user making the request. a ClientSessionId header must be provided and only actions which were performed the same user with the same ClientSessionId value set on the api request that performed the action will be redone.Additionally the ClientSessionId header must be between 1 and 256 characters long and must only contain alphanumeric or the - characters."
        },
        {
          "info": {
            "name": "reset_password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/reset-password/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the password of a user if the reset token is valid. The **send_password_reset_email** endpoint sends an email to the user containing the token. That token can be used to change the password here without providing the old password."
        },
        {
          "info": {
            "name": "schedule_account_deletion",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/schedule-account-deletion/",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Schedules the account deletion of the authenticated user. The user will be permanently deleted after the grace delay defined by the instance administrator."
        },
        {
          "info": {
            "name": "send_change_email_confirmation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/send-change-email-confirmation/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Sends an email to the new email address containing a confirmation link. The user must provide their current password to initiate this request. The link is going to be valid for 12 hours."
        },
        {
          "info": {
            "name": "send_password_reset_email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/send-reset-password-email/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sends an email containing the password reset link to the email address of the user. This will only be done if a user is found with the given email address. The endpoint will not fail if the email address is not found. The link is going to the valid for 2 hours."
        },
        {
          "info": {
            "name": "send_verify_email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/send-verify-email/",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Sends an email to the user with an email verification link if the user's email is not verified yet."
        },
        {
          "info": {
            "name": "token_auth",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/token-auth/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Authenticates an existing user based on their email and their password. If successful, an access token and a refresh token will be returned. If the account is protected with two-factor authentication, temporary token is returned to finish the verification."
        },
        {
          "info": {
            "name": "token_blacklist",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/token-blacklist/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Blacklists the provided token. This can be used the sign the user off."
        },
        {
          "info": {
            "name": "token_refresh",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/token-refresh/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate a new access_token that can be used to continue operating on Baserow starting from a valid refresh token."
        },
        {
          "info": {
            "name": "token_verify",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/token-verify/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verifies if the refresh token is valid and can be used to generate a new access_token."
        },
        {
          "info": {
            "name": "undo",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/user/undo/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "undoes the latest undoable action performed by the user making the request. a ClientSessionId header must be provided and only actions which were performed the same user with the same ClientSessionId value set on the api request that performed the action will be undone.Additionally the ClientSessionId header must be between 1 and 256 characters long and must only contain alphanumeric or the - characters."
        },
        {
          "info": {
            "name": "verify_email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/user/verify-email/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Passing the correct verification token will confirm that the user's email address belongs to the user. This endpoint also optionally returns user information, access token and the refresh token for automatically signing user in the system if the request is performed by unauthenticated user."
        }
      ]
    }
  ],
  "bundled": true
}