Document optional methods allowing auto_X_user features

diff --git a/Changes b/Changes
index 2abdc2f..ba2dbd9 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,5 +1,7 @@
 Revision history for Perl extension Catalyst::Plugin::Authentication
 
+    - Document optional methods in stores needed for auto_create_user
+      and auto_update_user in realms.
     - Clarify support channels
     - Note primary maintainer in docs.
     - Add x_authority metadata.

diff --git a/lib/Catalyst/Plugin/Authentication/Internals.pod b/lib/Catalyst/Plugin/Authentication/Internals.pod
index 9c2b0f6..6ca50c7 100644 (file)
--- a/lib/Catalyst/Plugin/Authentication/Internals.pod
+++ b/lib/Catalyst/Plugin/Authentication/Internals.pod
@@ -266,6 +266,19 @@ be able to function without an instantiated user object.
 
 =back
 
+=head3 OPTIONAL STORE METHODS
+
+If you want your store to be able to auto- create users, then you can
+implement these methods:
+
+=head24 auto_update_user( $authinfo, $c, $res )
+
+This method is called if the realm's auto_update_user setting is true.
+
+=head2 auto_create_user( $authinfo, $c )
+
+This method is called if the realm's auto_create_user setting is true.
+
 =head2 USER OBJECT
 
 The user object is an important piece of your store module. It will be the