Adding to readme and raml for deprecation

folio-org · Oct 6, 2023 · 02b8639 · 02b8639
1 parent dc2e9d2
commit 02b8639
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -152,3 +152,16 @@ The built artifacts for this module are available.
 See [configuration](https://dev.folio.org/download/artifacts) for repository access,
 and the [Docker image](https://hub.docker.com/r/folioorg/mod-users-bl/).
 
+### Password reset link expiration
+
+Operators should take care when setting configuration values for `RESET_PASSWORD_LINK_EXPIRATION_TIME` and
+`RESET_PASSWORD_LINK_EXPIRATION_UNIT_OF_TIME` to match either the default access token expiration or custom
+configured access token configuration for a given tenant, since the token expiration which is tied to the reset will
+use this expiration which is set in mod-authtoken. The `RESET_PASSWORD_LINK_EXPIRATION_TIME` and
+`RESET_PASSWORD_LINK_EXPIRATION_UNIT_OF_TIME` configuration parameters are used in the notification sent
+by the mod-users-bl module.
+
+
+
+
+
diff --git a/ramls/mod-users-bl.raml b/ramls/mod-users-bl.raml
@@ -189,7 +189,7 @@ resourceTypes:
     type: { compositeUserResource: { "typeName" : "self reference" } }
   /login:
     post:
-      description: Allow a new user to login and return an authtoken, along with a composite user record
+      description: Allow a new user to login and return an authtoken, along with a composite user record. Deprecated and will be removed in a future release. Please use /login-with-expiry.
       is: [permissionsExpandable, includeable]
       headers:
         User-Agent: