diff --git a/documentation/docs-index.js b/documentation/docs-index.js index 1d5ba94c..f9cd5929 100644 --- a/documentation/docs-index.js +++ b/documentation/docs-index.js @@ -41,7 +41,8 @@ module.exports = { "auth/me", "auth/logout", "auth/register", - "auth/recover" + "auth/recover", + "auth/token" ] }, }; diff --git a/documentation/docs/auth/token.md b/documentation/docs/auth/token.md new file mode 100644 index 00000000..8655bfdd --- /dev/null +++ b/documentation/docs/auth/token.md @@ -0,0 +1,87 @@ +--- +id: token +title: Confirm Recovery Token +sidebar_label: Confirm Recovery Token +slug: /auth/token +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +import Highlight from "../../src/highlight.js" + +## Details + +This endpoint is used to check if the given token is valid to recover an account. +The token can be generated by using the [recover](./recover.md) endpoint and is sent to the user by email. + +**URL** : `/auth/recover/:token/confirm` + +**Method** : GET + +## Request examples + +### Example 1 - Valid Token + +**Code** : 200 OK + + + + + +```bash +/auth/recover/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6Im5pQGFlZmV1cC5wdCIsImlhdCI6MTY2MzAxMzg0OSwiZXhwIjoxNjYzMDE0NDQ5fQ.k5Z_nBpqt_Hs8JBhLH0ZXTl2-BG-utdIAUdhKXEFuFc/confirm +``` + + + + + +```json +{} +``` + + + + +### Example 2 - Invalid Token + +**Code** : 403 FORBIDDEN + + + + + +```bash +/auth/recover/invalid/confirm +``` + + + + + +```json +{ + "error_code": 3, + "errors": [ + { + "msg": "invalid-token" + } + ] +} +``` + + +