Documentation (2024.2 Enterprise)

# Password Recovery

Password recoveries can be generated and used when a User or Collaborator has forgotten their Helix TeamHub password and needs a new one.

Please note that operations in Password Recoveries API do not require authentication.

- Attributes
- Operations
  - `POST /account/password_recoveries`
  - `GET /account/password_recoveries/:id`
  - `PUT /account/password_recoveries/:id`

## Attributes

### id

A unique token used for resetting the password. Generated by Helix TeamHub and delivered to the user in question via email in the form of a password recovery link. Must be provided with GET and PUT requests.

- Type: `string`

### email

The email address of the user whose password is being recovered. An email will be sent to the user, instructing them on the password recovery process.

- Type: `string`

### password

The new password to set. Required on PUT. Validations depend on instance specific configurations.

- Type: `string`
- Default minimum length: `8`
- Default maximum length: `100`

## Operations

### POST /account/password_recoveries

Creates a new password recovery token. Attempts to find the user by email and sends a password recovery email if found. The endpoint will always return 201 (even if the email does not really exist).

#### Example Request

    curl -X POST
      -H "Accept: application/vnd.hth.v1" \
      -F "email=clark.kent@eficode.com" \
      https://helixteamhub.cloud/api/account/password_recoveries

#### Example Response

    {
      "api_status": 201
    }

### GET /account/password_recoveries/:id

Returns the user's email and its Company ID when found by the given password recovery token.

#### Example Request

    curl -X GET
      -H "Accept: application/vnd.hth.v1" \
      https://helixteamhub.cloud/api/account/password_recoveries/2eb8ba99d5b4fdbbe26abda420195eb192f6c2ed63f063180f40479eb6865e7e

#### Example Response

    {
      "api_status": 200,
      "company": "hth",
      "email": "clark.kent@company.com"
    }

### PUT /account/password_recoveries/:id

Resets the user's password. Returns the user's email and its Company ID on success and validation errors on failure.

#### Example Request

    curl -X PUT
      -H "Accept: application/vnd.hth.v1" \
      -F "password=Clar!Ken7" \
      https://helixteamhub.cloud/api/account/password_recoveries/2eb8ba99d5b4fdbbe26abda420195eb192f6c2ed63f063180f40479eb6865e7e

#### Example Response

    {
      "api_status": 200,
      "company": "hth",
      "email": "clark.kent@company.com"
    }

Your search for returned results

Your search for returned results