Products.PluggableAuthService

Purpose

The PluggableAuthService is designed to allow incorporation of any existing user folder (or related technology), and to make it simple to define project-specific extensions.

Theory of Operation

The PluggableAuthService defines a framework for a set of plugins which it orchestrates to generate user objects from requests. These user objects implement the “traditional” BasicUser API, and provide additional functionality.

Narrative documentation

Narrative documentation explaining how to use Products.PluggableAuthService.

• Plugins
  • Plugin Types
  • Plugin Registration
• Request flow
• Caching
  • How does the site admin use it?
  • How does a plugin programmer use it?
  • CAVEATS

API documentation

API documentation for Products.PluggableAuthService.

• User objects
  • IBasicUser
  • IPropertiedUser
• User property sheets
  • IPropertySheet
• User Folder objects
  • IUserFolder
  • IPluggableAuthService
  • IMutableUserFolder
  • IEnumerableUserFolder
• Plugins
  • IExtractionPlugin
  • ILoginPasswordExtractionPlugin
  • ILoginPasswordHostExtractionPlugin
  • IAuthenticationPlugin
  • IChallengePlugin
  • ICredentialsUpdatePlugin
  • ICredentialsResetPlugin
  • IUserAdderPlugin
  • IRoleAssignerPlugin
  • IUserFactoryPlugin
  • IAnonymousUserFactoryPlugin
  • IPropertiesPlugin
  • IGroupsPlugin
  • IRolesPlugin
  • IUpdatePlugin
  • IValidationPlugin
  • IUserEnumerationPlugin
  • IGroupEnumerationPlugin
  • IRoleEnumerationPlugin
  • IRequestTypeSniffer
  • IChallengeProtocolChooser
  • INotCompetentPlugin
• Events
  • IPASEvent
  • IPrincipalCreatedEvent
  • IUserLoggedInEvent
  • IUserLoggedOutEvent
  • IPrincipalDeletedEvent
  • ICredentialsUpdatedEvent
  • IPropertiesUpdatedEvent
  • IGroupDeletedEvent
• Requests
  • IRequest
  • IHTTPRequest
  • IBrowserRequest
  • IWebDAVRequest
  • IXMLRPCRequest

Changes

• Change Log
  • 4.2 (unreleased)
  • 4.1 (2025-11-19)
  • 4.0 (2025-11-19)
  • 3.0 (2024-01-22)
  • 2.8.1 (2022-12-18)
  • 2.8.0 (2022-12-16)
  • 2.7.1 (2022-10-04)
  • 2.7.0 (2022-01-04)
  • 2.6.4 (2021-07-28)
  • 2.6.3 (2021-06-08)
  • 2.6.2 (2021-03-12)
  • 2.6.1 (2021-02-26)
  • 2.6.0 (2021-02-23)
  • 2.5.1 (2020-11-13)
  • 2.5 (2020-10-12)
  • 2.4 (2020-02-09)
  • 2.3 (2020-02-02)
  • 2.2.1 (2020-01-13)
  • 2.2 (2019-11-23)
  • 2.1.1 (2019-10-23)
  • 2.1 (2019-08-29)
  • 2.0 (2019-05-10)
  • 2.0b6 (2019-04-17)
  • 2.0b5 (2019-04-13)
  • 2.0b4 (2019-04-04)
  • 2.0b3 (2019-03-29)
  • 2.0b2 (2018-10-16)
  • 2.0b1 (2018-05-18)
  • 1.11.0 (2016-03-01)
  • 1.10.0 (2013-02-19)
  • 1.9.0 (2012-08-30)
  • 1.8.0 (2012-05-08)
  • 1.7.8 (2012-05-08)
  • 1.7.7 (2012-02-27)
  • 1.7.6 (2011-10-31)
  • 1.7.5 (2011-05-30)
  • 1.7.4 (2011-05-13)
  • 1.7.3 (2011-02-10)
  • 1.7.2 (2010-11-11)
  • 1.7.1 (2010-07-01)
  • 1.7.0 (2010-04-08)
  • 1.7.0b2 (2010-01-31)
  • 1.7.0b1 (2009-11-16)
  • 1.6.2 (2009-11-16)
  • 1.6.1 (2008-11-20)
  • 1.6 (2008-08-05)
  • 1.5.3 (2008-02-06)
  • 1.5.2 (2007-11-28)
  • 1.5.1 (2007-09-11)
  • 1.5 (2006-06-17)
  • 1.4 (2006-08-28)
  • 1.4-beta (2006-08-07)
  • 1.3 (2006-06-09)
  • 1.3-beta (2006-06-03)
  • 1.2 (2006-05-14)
  • 1.2-beta (2006-02-25)
  • 1.1b2 (2005-07-14)
  • 1.1b1 (2005-07-06)
  • 1.0.5 (2005-01-31)
  • 1.0.4 (2005-01-27)
  • 1.0.3 (2004-10-16)
  • 1.0.2 (2004-07-15)
  • 1.0.1 (2004-05-18)
  • 1.0 (2004-04-29)

Indices and tables

• Index

• Module Index

• Search Page