ESC

    User

    The user endpoint allows to manage the users of the Query Server.

    POST

    The user endpoint allows to create a new user.

    POST /_/user
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    Body

    NameTypeDescriptionDefaultRequired
    emailstringThe email of the user.-true
    passwordstringThe password of the user.-true
    adminbooleanIf the user is admin.falsefalse
    activebooleanIf the user is active.truefalse

    Example:

    {
      "email": "example@example.com",
      "password": "example",
      "admin": false,
      "active": true
    }
    

    PUT

    The user endpoint allows to update a user.

    PUT /_/user
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    Body

    NameTypeDescriptionDefaultRequired
    emailstringThe email of the user.-true
    new_emailstringThe new email of the user.-false
    new_passwordstringThe new password of the user.-false
    adminbooleanIf the user is admin.falsefalse
    activebooleanIf the user is active.truefalse

    Example:

    {
      "email": "example@example.com",
      "new_email": "new-example@example.com",
      "new_password": "example",
      "admin": false,
      "active": true
    }
    

    DELETE

    The user endpoint allows to delete a user.

    DELETE /_/user
    

    Headers

    NameTypeDescriptionRequired
    AuthorizationstringThe bearer token to connect to the server.true

    Body

    NameTypeDescriptionRequired
    emailstringThe email of the user.true

    Example:

    {
      "email": "example@example.com"
    }