Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the Reset password API documentation #3334

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 103 additions & 0 deletions api/enterprise-api-ref/reset-password.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
layout: default
title: Reset password API
published: true
---

## Request reset password link and token

This call initiates the password reset process by sending a reset password
link and token to the user's registered email address. User can click the link from the email
and set a new password in the Mission Portal or invalidate the request.
Every request has an expiration time equal to 48 hours.
Comment on lines +9 to +12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am pretty sure that for markdown we can use one-sentence-per-line which is easier to edit/manipulate/see changes.

Suggested change
This call initiates the password reset process by sending a reset password
link and token to the user's registered email address. User can click the link from the email
and set a new password in the Mission Portal or invalidate the request.
Every request has an expiration time equal to 48 hours.
This call initiates the password reset process by sending a reset password link and token to the user's registered email address. User can click the link from the email and set a new password in the Mission Portal or invalidate the request.
Every request has an expiration time equal to 48 hours.


**URI:** https://hub.cfengine.com/api/auth/password/forgot/:username

**Method:** POST

**Example request (curl):**

```console
curl -X POST \
https://hub.cfengine.com/api/auth/password/forgot/admin
```

**Successful response example:**

```
HTTP 200 Ok

Reset password email successfully sent.
```

**Responses:**

| HTTP response code | Description |
|--------------------------|---------------------------------------------------------------|
| 200 OK | Check your email for the link to reset your password. |
| 422 Unprocessable Entity | We are unable to reset the password at this time. |


## Reset password by token

This call provides possibility to change password by reset password token
from the [Request reset password link and token][Reset password API#Request reset password link and token] endpoint.

**URI:** https://hub.cfengine.com/api/auth/password/reset/:token

**Method:** POST

**Example request (curl):**

```console
curl -X POST \
--data-raw '{"password": "new password"}' \
https://hub.cfengine.com/api/auth/password/reset/v1twknmrLWos
```

**Successful response example:**

```
HTTP 200 Ok

Reset password email successfully sent.
```

**Responses:**

| HTTP response code | Description |
|--------------------------|-----------------------------------------------------------------|
| 200 OK | Password successfully changed. |
| 422 Unprocessable Entity | Password validation error or the request cannot be processed. |
| 429 Too Many Requests | We have detected multiple unsuccessful reset password attempts. |


## Invalidate reset password token

This call provides possibility to invalidate reset password token
from the [Request reset password link and token][Reset password API#Request reset password link and token] endpoint.

**URI:** https://hub.cfengine.com/api/auth/password/reset/:token

**Method:** DELETE

**Example request (curl):**

```console
curl -X DELETE https://hub.cfengine.com/api/auth/password/reset/v1twknmrLWos
```

**Successful response example:**

```
HTTP 202 Accepted

Reset password token successfully invalidated.
```

**Responses:**

| HTTP response code | Description |
|--------------------------|------------------------------------------------|
| 202 Accepted | Reset password token successfully invalidated. |
| 422 Unprocessable Entity | Unable to process request. |
Loading