Skip to content

Commit 19a9ba2

Browse files
committed
Update readme
1 parent 61277c3 commit 19a9ba2

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,27 @@ You are done with the installation!
2727

2828
## Usage
2929

30-
This will add 3 mutations to your GraphQL API
30+
This will add 5 mutations to your GraphQL API
3131

3232
```js
3333
extend type Mutation {
3434
login(data: LoginInput): AuthPayload!
3535
refreshToken(data: RefreshTokenInput): AuthPayload!
3636
logout: LogoutResponse!
37+
forgotPassword(data: ForgotPasswordInput!): ForgotPasswordResponse!
38+
updateForgottenPassword(data: NewPasswordWithCodeInput): ForgotPasswordResponse!
3739
}
3840
```
3941

4042
- **login:** Will allow your clients to log in by using the password grant client.
4143
- **refreshToken:** Will allow your clients to refresh a passport token by using the password grant client.
4244
- **logout:** Will allow your clients to invalidate a passport token.
45+
- **forgotPassword:** Will allow your clients to request the forgot password email.
46+
- **updateForgottenPassword:** Will allow your clients to update the forgotten password from the email received.
4347

4448
### Why the OAuth client is used in the backend and not from the client application?
4549

46-
When an application that needs to be re compiled and re deploy to stores like an iOS app needs to change the client for whatever reason, it becomes a blocker for QA or even if the client is removed. The app will not work until the new version with the updated keys is deployed. There are alternatives to store this configuration in the client but fot this use case we are relying on the backend to be the OAuth client
50+
When an application that needs to be re compiled and re deploy to stores like an iOS app needs to change the client for whatever reason, it becomes a blocker for QA or even brakes the production app if the client is removed. The app will not work until the new version with the updated keys is deployed. There are alternatives to store this configuration in the client but for this use case we are relying on the backend to be the OAuth client
4751

4852
## Change log
4953

0 commit comments

Comments
 (0)