-
Notifications
You must be signed in to change notification settings - Fork 75
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
aleksandrychev
wants to merge
1
commit into
cfengine:master
Choose a base branch
from
aleksandrychev:ENT-10837
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
**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. | |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.