Passwords

Headers

Params

Examples

// With invalid parameters
POST /api/v2/users/password
{
  "password": "pAssWoRd!",
  "password_confirmation": "password",
  "confirmation_token": "E79ytVM1ZSG4jjXx9UhR"
}
400
{
  "error": "Setting password failed"
}

// With invalid parameters
POST /api/v2/users/password
{
  "password": "pAssWoRd!112345",
  "password_confirmation": "pAssWoRd!112345",
  "confirmation_token": "hulabaloo"
}
400
{
  "error": "Invalid token"
}

// Succesful request
POST /api/v2/users/password
{
  "password": "SamuLinV3rhot!",
  "password_confirmation": "SamuLinV3rhot!",
  "confirmation_token": "AUHkZWzUfyCu65vspQZM"
}
200
{
  "ok": "User password set and account confirmed"
}

Errors

Headers

Params

Examples

// When missing required parameters
POST /api/v2/users/password/reset
422
{
  "error": "Missing parameter email"
}

// Successful request
POST /api/v2/users/password/reset
{
  "email": "new-user-created@example.com"
}
200
{
  "ok": "Password reset instructions were sent to the given email if it is found in our system"
}

Errors

Headers

Params

Examples

// Passwords not matching
PUT /api/v2/users/password
{
  "password": "coMplexEnoughButNotMatching!",
  "password_confirmation": "OopsieWoopsieNotMatching123",
  "reset_password_token": "fojoiZtvYZXLBovyRrsF"
}
400
{
  "error": {
    "password_confirmation": [
      "doesn't match Password"
    ]
  }
}

// Weak password
PUT /api/v2/users/password
{
  "password": "weakpass",
  "password_confirmation": "weakpass",
  "reset_password_token": "xn_m169WGZ_DV5PejrKu"
}
400
{
  "error": {
    "password": [
      "not strong enough. It scored 1. It must score at least 3."
    ]
  }
}

// Invalid reset_password_token
PUT /api/v2/users/password
{
  "password": "pAssWoRd!112345",
  "password_confirmation": "pAssWoRd!112345",
  "reset_password_token": "hulabaloo"
}
400
{
  "error": {
    "reset_password_token": [
      "is invalid"
    ]
  }
}

// Successful request
PUT /api/v2/users/password
{
  "password": "SamuLinV3rhot!",
  "password_confirmation": "SamuLinV3rhot!",
  "reset_password_token": "mtS9ukGV5qTx_exCSx6u"
}
200
{
  "ok": "Password was reset successfully"
}

Errors