Update docs

Author: joshuachinemezu

README.md

@@ -64,6 +64,7 @@ class AuthMutation(graphene.ObjectType):
     resend_activation_email = mutations.ResendActivationEmail.Field()
     send_password_reset_email = mutations.SendPasswordResetEmail.Field()
     password_reset = mutations.PasswordReset.Field()
+    password_set = mutations.PasswordSet.Field() # For passwordless registration
     password_change = mutations.PasswordChange.Field()
     update_account = mutations.UpdateAccount.Field()
     archive_account = mutations.ArchiveAccount.Field()

docs/api.md

@@ -351,6 +351,130 @@ mutation {
 }
 ```
 
+---
+#### PasswordSet
+
+{{ api.PasswordSet }}
+
+```bash tab="graphql"
+mutation {
+  passwordSet(
+    token: "1eyJ1c2VybmFtZSI6InNreXdhbGtlciIsImFjdGlvbiI6InBhc3N3b3JkX3Jlc2V0In0:1itExL:op0roJi-ZbO9cszNEQMs5mX3c6s",
+    newPassword1: "supersecretpassword",
+    newPassword2: "supersecretpassword"
+  ) {
+    success,
+    errors
+  }
+}
+```
+
+```bash tab="success"
+{
+  "data": {
+    "passwordSet": {
+      "success": true,
+      "errors": null
+    }
+  }
+}
+```
+
+```bash tab="relay"
+mutation {
+  passwordSet(
+    input: {
+      token: "1eyJ1c2VybmFtZSI6InNreXdhbGtlciIsImFjdGlvbiI6InBhc3N3b3JkX3Jlc2V0In0:1itExL:op0roJi-ZbO9cszNEQMs5mX3c6s",
+      newPassword1: "supersecretpassword",
+      newPassword2: "supersecretpassword"
+    }
+  ) {
+    success,
+    errors
+  }
+}
+```
+
+```bash tab="Invalid token"
+{
+  "data": {
+    "passwordSet": {
+      "success": false,
+      "errors": {
+        "nonFieldErrors": [
+          {
+            "message": "Invalid token.",
+            "code": "invalid_token"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+```bash tab="Password mismatch"
+{
+  "data": {
+    "passwordSet": {
+      "success": false,
+      "errors": {
+        "newPassword2": [
+          {
+            "message": "The two password fields didn’t match.",
+            "code": "password_mismatch"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+```bash tab="Password validators"
+{
+  "data": {
+    "passwordSet": {
+      "success": false,
+      "errors": {
+        "newPassword2": [
+          {
+            "message": "This password is too short. It must contain at least 8 characters.",
+            "code": "password_too_short"
+          },
+          {
+            "message": "This password is too common.",
+            "code": "password_too_common"
+          },
+          {
+            "message": "This password is entirely numeric.",
+            "code": "password_entirely_numeric"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+```bash tab="Password Set"
+{
+  "data": {
+    "passwordSet": {
+      "success": false,
+      "errors": {
+        "nonFieldErrors": [
+          {
+            "message": "Password already set for account.",
+            "code": "password_already_set"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
 ---
 
 #### PasswordReset

docs/data/api.yml

@@ -73,6 +73,17 @@ PasswordReset: |
 
     Also, if user has not been verified yet, verify it.
     
+PasswordSet: |
+    Set user password - for passwordless registration
+
+    Receive the token that was sent by email.
+
+    If token and new passwords are valid, set
+    user password and in case of using refresh
+    tokens, revoke all of them.
+
+    Also, if user has not been verified yet, verify it.
+    
 ObtainJSONWebToken: |
     Obtain JSON web token for given user.
 

docs/index.md

@@ -46,6 +46,7 @@ your implementation^^.
 * [x] All mutations return `success` and `errors`
 * [x] Default email templates <small>(you will customize though)</small>
 * [x] Customizable, no lock-in
+* [x] Passwordless registration
 
 ---
 

docs/installation.md

@@ -65,6 +65,7 @@ class AuthMutation(graphene.ObjectType):
     resend_activation_email = mutations.ResendActivationEmail.Field()
     send_password_reset_email = mutations.SendPasswordResetEmail.Field()
     password_reset = mutations.PasswordReset.Field()
+    password_set = mutations.PasswordSet.Field() # For passwordless registration
     password_change = mutations.PasswordChange.Field()
     update_account = mutations.UpdateAccount.Field()
     archive_account = mutations.ArchiveAccount.Field()
@@ -105,6 +106,7 @@ class AuthRelayMutation(graphene.ObjectType):
     resend_activation_email = relay.ResendActivationEmail.Field()
     send_password_reset_email = relay.SendPasswordResetEmail.Field()
     password_reset = relay.PasswordReset.Field()
+    password_set = relay.PasswordSet.Field() # For passwordless registration
     password_change = relay.PasswordChange.Field()
     update_account = relay.UpdateAccount.Field()
     archive_account = relay.ArchiveAccount.Field()

docs/settings.md

@@ -32,6 +32,14 @@ If a user has a secondary email set, he can use to login.
 
 default: `#!python True`
 
+### ALLOW_PASSWORDLESS_REGISTRATION
+
+To allow registration with no password; Django `set_unusable_password()` will be used in setting the default password.
+
+- User cannot login until they set their password
+
+default: `#!python False`
+
 ### ALLOW_DELETE_ACCOUNT
 
 Instead of deleting the account, make `#!python user.is_active=False`.
@@ -48,6 +56,12 @@ Note that users will still have an `#!python verified=False` status.
 
 default: `#!python True`
 
+### SEND_PASSWORD_SET_EMAIL
+
+If set to `#!python True`, user will be notified to set their password after registration - dependent on `ALLOW_PASSWORDLESS_REGISTRATION`.
+
+default: `#!python False`
+
 ---
 
 ## Dynamic Fields
@@ -158,6 +172,10 @@ default: `#!python timedelta(hours=1)`
 
 default: `#!python timedelta(hours=1)`
 
+### EXPIRATION_PASSWORD_SET_TOKEN
+
+default: `#!python timedelta(days=7)`
+
 ---
 
 ## Email
@@ -180,6 +198,12 @@ Path [variable](overriding-email-templates.md) used in password reset email.
 
 default: `#!python "password-reset"`
 
+### PASSWORD_SET_PATH_ON_EMAIL
+
+Path [variable](overriding-email-templates.md) used in password set email.
+
+default: `#!python "password-set"`
+
 ### ACTIVATION_SECONDARY_EMAIL_PATH_ON_EMAIL
 
 Path [variable](overriding-email-templates.md) used in secondary email activation email.
@@ -237,6 +261,10 @@ default: `#!python "email/activation_subject.txt"`
 
 default: `#!python "email/password_reset_subject.txt"`
 
+### EMAIL_SUBJECT_PASSWORD_SET
+
+default: `#!python "email/password_set_subject.txt"`
+
 
 ---
 
@@ -261,6 +289,10 @@ default: `#!python "email/activation_email.html"`
 
 default: `#!python "email/password_reset_email.html"`
 
+### EMAIL_TEMPLATE_PASSWORD_SET
+
+default: `#!python "email/password_set_email.html"`
+
 ### EMAIL_TEMPLATE_VARIABLES
 
 default: `#!python {}`

quickstart/quickstart/schema.py

@@ -12,6 +12,7 @@ class AuthMutation(graphene.ObjectType):
     resend_activation_email = mutations.ResendActivationEmail.Field()
     send_password_reset_email = mutations.SendPasswordResetEmail.Field()
     password_reset = mutations.PasswordReset.Field()
+    password_set = mutations.PasswordSet.Field()
     password_change = mutations.PasswordChange.Field()
     archive_account = mutations.ArchiveAccount.Field()
     delete_account = mutations.DeleteAccount.Field()