Skip to content
TestLookupTestLookup
Search Ctrl K

Search TestLookup

Enter a term to search the local static index.

    First Time Reset — POST /api/v1/auth/first-time-reset

    First Time Reset

    Forced password reset for self-registered users on first login.

    Endpoint: POST /api/v1/auth/first-time-reset

    Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.

    NameInRequiredTypeDefaultDescription
    X-API-Keyheadernostring or nullAPI key, as an alternative to the access token (see Authentication).
    Content typeBodyRequired
    application/jsonFirstTimeResetRequestyes
    StatusMeaningBody
    204Successful ResponseNo body
    422Validation ErrorHTTPValidationError (application/json)

    204 returns no body.

    Errors this endpoint returns, read from its source code:

    • 400, with the message “Passwords do not match”
    • 403, with the message “Password reset not required for this account. Use change-password instead”
    • 503, with the message “Token revocation store unavailable; password reset was not applied”

    It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.