User objects

interface Products.PluggableAuthService.interfaces.authservice.IBasicUser[source]

Specify the interface called out in AccessControl.User.BasicUser as the “Public User object interface”, except that ‘_getPassword’ is not part of the contract!

getId()

Get the ID of the user.

o The ID can be used, at least from Python, to get the user from
the user’s UserDatabase
getUserName()

Return the name used by the user to log into the system.

o Note that this may not be identical to the user’s ‘getId’
(to allow users to change their login names without changing their identity).
getRoles()

Return the roles assigned to a user “globally”.

getRolesInContext(object)

Return the roles assigned to the user in context of ‘object’.

o Roles include both global roles (ones assigned to the user
directly inside the user folder) and local roles (assigned in context of the passed in object.
getDomains()

Return the list of domain restrictions for a user.

interface Products.PluggableAuthService.interfaces.authservice.IPropertiedUser[source]

Extends: Products.PluggableAuthService.interfaces.authservice.IBasicUser

A user which has property sheets associated with it, i.e. a mapping from strings (property sheet ids) to objects implementing IPropertySheet

addPropertysheet(id, data)

Add a new property sheet to the user.

The property sheet has to be a map or an IPropertySheet instance.

listPropertysheets()

Return a sequence of property sheet ids

o for each id in the list getPropertysheet(id)
returns a IPropertySheet
getPropertysheet(id)

Return a property sheet for the given id

o the returned object implements IPropertySheet
and has the same id as the value passed to this method
o if there is no property sheet for the given id,

raise a KeyError

An alternative way to get the property sheet is via item access, i.e. user.getPropertysheet(id) == user[ id ]