Back to index

plone3  3.1.7
Public Member Functions
PluggableAuthService.interfaces.plugins.IUserEnumerationPlugin Class Reference
Inheritance diagram for PluggableAuthService.interfaces.plugins.IUserEnumerationPlugin:
Inheritance graph
[legend]
Collaboration diagram for PluggableAuthService.interfaces.plugins.IUserEnumerationPlugin:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def enumerateUsers

Detailed Description

Allow querying users by ID, and searching for users.

o XXX:  can these be done by a single plugin?

Definition at line 294 of file plugins.py.


Member Function Documentation

def PluggableAuthService.interfaces.plugins.IUserEnumerationPlugin.enumerateUsers (   id = None,
  login = None,
  exact_match = False,
  sort_by = None,
  max_results = None,
  kw 
)
Allow querying users by ID, and searching for users.

o XXX:  can these be done by a single plugin?
-> ( user_info_1, ... user_info_N )

o Return mappings for users matching the given criteria.

o 'id' or 'login', in combination with 'exact_match' true, will
  return at most one mapping per supplied ID ('id' and 'login'
  may be sequences).

o If 'exact_match' is False, then 'id' and / or login may be
  treated by the plugin as "contains" searches (more complicated
  searches may be supported by some plugins using other keyword
  arguments).

o If 'sort_by' is passed, the results will be sorted accordingly.
  known valid values are 'id' and 'login' (some plugins may support
  others).

o If 'max_results' is specified, it must be a positive integer,
  limiting the number of returned mappings.  If unspecified, the
  plugin should return mappings for all users satisfying the criteria.

o Minimal keys in the returned mappings:

  'id' -- (required) the user ID, which may be different than
  the login name

  'login' -- (required) the login name

  'pluginid' -- (required) the plugin ID (as returned by getId())

  'editurl' -- (optional) the URL to a page for updating the
       mapping's user

o Plugin *must* ignore unknown criteria.

o Plugin may raise ValueError for invalid criteria.

o Insufficiently-specified criteria may have catastrophic
  scaling issues for some implementations.

Definition at line 307 of file plugins.py.

00307 
00308                       ):
00309 
00310         """ -> ( user_info_1, ... user_info_N )
00311 
00312         o Return mappings for users matching the given criteria.
00313 
00314         o 'id' or 'login', in combination with 'exact_match' true, will
00315           return at most one mapping per supplied ID ('id' and 'login'
00316           may be sequences).
00317 
00318         o If 'exact_match' is False, then 'id' and / or login may be
00319           treated by the plugin as "contains" searches (more complicated
00320           searches may be supported by some plugins using other keyword
00321           arguments).
00322 
00323         o If 'sort_by' is passed, the results will be sorted accordingly.
00324           known valid values are 'id' and 'login' (some plugins may support
00325           others).
00326 
00327         o If 'max_results' is specified, it must be a positive integer,
00328           limiting the number of returned mappings.  If unspecified, the
00329           plugin should return mappings for all users satisfying the criteria.
00330 
00331         o Minimal keys in the returned mappings:
00332         
00333           'id' -- (required) the user ID, which may be different than
00334                   the login name
00335 
00336           'login' -- (required) the login name
00337 
00338           'pluginid' -- (required) the plugin ID (as returned by getId())
00339 
00340           'editurl' -- (optional) the URL to a page for updating the
00341                        mapping's user
00342 
00343         o Plugin *must* ignore unknown criteria.
00344 
00345         o Plugin may raise ValueError for invalid criteria.
00346 
00347         o Insufficiently-specified criteria may have catastrophic
00348           scaling issues for some implementations.
00349         """


The documentation for this class was generated from the following file: