Reset Users E2E Key
    • Dark
      Light
    • PDF

    Reset Users E2E Key

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/users.resetE2EKey

    Reset the E2E key for a user in the workspace.

    • It requires the edit-other-user-e2ee permission.
    • This endpoint requires 2FA.

    Changelog

    VersionDescription
    3.6.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authenticated user token.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The authenticated user ID.

    ExamplerbAXPnMktTFbNpwtJ
    x-2fa-code
    stringRequired
    Example148750
    x-2fa-method
    stringRequired

    The desired method to get the 2FA code. It can be email, totp, or password.

    Body parameters
    Example 1
    {
      "userId": "GonjPyg3gB3Z9ur9s"
    }
    object
    userId
    string

    The userId of the user whose e2e key you want to reset. You can also use the username. If you don't enter a value, the sender's E2E value is reset.

    Responses
    200

    OK

    Success
    {
      "success": true
    }
    object
    success
    boolean
    400

    Bad Request

    Example 1
    {
      "success": false,
      "error": "TOTP Required [totp-required]",
      "errorType": "totp-required",
      "details": {
        "method": "password",
        "codeGenerated": false,
        "availableMethods": []
      }
    }
    Example 2
    {
      "success": false,
      "error": "Not allowed [error-not-allowed]",
      "errorType": "error-not-allowed"
    }
    Example 3
    {
      "success": false,
      "error": "The required \"userId\" or \"username\" param provided does not match any users [error-invalid-user]",
      "errorType": "error-invalid-user"
    }
    Expand All
    object
    success
    boolean
    error
    string
    errorType
    string
    details
    object
    method
    string
    codeGenerated
    boolean
    availableMethods
    Array of object
    object
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.