zms._accessmanager.AccessManager

class documentation

class AccessManager(AccessableContainer): (source)

Main access-management mixin for users, roles, and local permissions.

Method	`delLocalUser`	Remove a local user assignment from a node.
Method	`delUser`	Delete a user and all of its configured assignments.
Method	`delUserAttr`	Remove a stored user configuration entry.
Method	`findUser`	Return the normalized user record for a given user id.
Method	`getRoleName`	Return the localized display name for a role.
Method	`getSearchableAttrs`	Return searchable attributes supported by the current user folder.
Method	`getSecurityRoles`	Return configured security-role definitions relevant for this home context.
Method	`getSecurityUsers`	Return configured security-user definitions for this home context.
Method	`getUserAdderPlugin`	Return the plugin responsible for creating and deleting users.
Method	`getUserAttr`	Retrieve a stored or derived user attribute.
Method	`getUserDefinedRoles`	Return user-defined roles from both the home object and the current object.
Method	`getUserFolder`	Return the active user folder, creating a default one if necessary.
Method	`getValidUserids`	Query user-folder backends and return normalized user records.
Method	`initRoleDefs`	Initialize built-in role definitions and synchronize public access.
Method	`manage_roleProperties`	Create, update, or delete role definitions and role-node bindings.
Method	`manage_userProperties`	Create, update, delete, import, export, or invite managed users.
Method	`purgeLocalUsers`	Remove stale local user assignments from a subtree.
Method	`searchUsers`	Search the underlying user folder for matching users.
Method	`setLocalUser`	Assign a local user definition to a node and set local roles.
Method	`setUserAttr`	Persist a user attribute in the central security configuration.
Method	`toggleUserActive`	Apply or remove local roles depending on the user's active state.
Class Variable	`manage_users`	Undocumented
Class Variable	`manage_users_sitemap`	Undocumented

Inherited from AccessableContainer:

Method	`grantPublicAccess`	Grant anonymous and authenticated public access for this container.
Method	`revokePublicAccess`	Revoke public access and restore restricted permission handling.
Method	`synchronizeRolesAccess`	Synchronize local role permission settings for this container.

Inherited from AccessableObject (via AccessableContainer):

Method	`getUserLangs`	Resolve effective language permissions for a user on this object.
Method	`getUserRoles`	Resolve effective user roles for this object.
Method	`getUsers`	Return all users with effective roles and languages on this object.
Method	`hasAccess`	Check whether the authenticated user can view this object.
Method	`hasPublicAccess`	Return whether public access is effectively allowed for this object.
Method	`hasRestrictedAccess`	Return whether this object is explicitly marked as restricted.
Method	`manage_user`	Update properties of the currently authenticated user.
Method	`synchronizePublicAccess`	Synchronize public-access permissions with the current restriction flags.
Method	`zmi_page_request`	Preprocess ZMI page requests and enforce access restrictions.
Class Variable	`manage_userForm`	Undocumented

def delLocalUser(self, id, node): (source) ¶

Remove a local user assignment from a node.

Parameters
id:`str`	User id
node:`str`	Node reference path

def delUser(self, id): (source) ¶

Delete a user and all of its configured assignments.

Parameters
id:`str`	User id

def delUserAttr(self, user): (source) ¶

Remove a stored user configuration entry.

Parameters
user	User reference

def findUser(self, name): (source) ¶

Return the normalized user record for a given user id.

Parameters
name:`str`	User id or login name
Returns
`dict`	User record or `None`

def getRoleName(self, role): (source) ¶

Return the localized display name for a role.

Parameters
role:`str`	Role id
Returns
`str`	Localized role name

def getSearchableAttrs(self): (source) ¶

Return searchable attributes supported by the current user folder.

def getSecurityRoles(self): (source) ¶

Return configured security-role definitions relevant for this home context.

def getSecurityUsers(self, acquired=False): (source) ¶

Return configured security-user definitions for this home context.

Parameters
acquired:`bool`	Include acquired users from parent homes
Returns
`dict`	User definition mapping

def getUserAdderPlugin(self): (source) ¶

Return the plugin responsible for creating and deleting users.

def getUserAttr(self, user, name=None, default=None): (source) ¶

Retrieve a stored or derived user attribute.

Parameters
user	User reference
name:`str`	Attribute name
default	Default value if attribute is missing
Returns
Attribute value or full user definition

def getUserDefinedRoles(self): (source) ¶

Return user-defined roles from both the home object and the current object.

def getUserFolder(self): (source) ¶

Return the active user folder, creating a default one if necessary.

def getValidUserids(self, search_term='', search_term_param=None, without_node_check=True, exact_match=False): (source) ¶

Query user-folder backends and return normalized user records.

Parameters
search_term:`str`	Search string
search_term_param:`str`	Optional backend-specific search attribute
without_node_check:`bool`	Whether to skip local-role checks for simple folders
exact_match:`bool`	Whether to return a single exact-match record
Returns
Normalized user record or table data depending on `exact_match`

def initRoleDefs(self): (source) ¶

Initialize built-in role definitions and synchronize public access.

def manage_roleProperties(self, btn, key, lang, REQUEST, RESPONSE=None): (source) ¶

Create, update, or delete role definitions and role-node bindings.

Parameters
btn:`str`	Action button id
key:`str`	Edited object type selector
lang:`str`	UI language id
REQUEST	Zope request object
RESPONSE	Optional Zope response object

def manage_userProperties(self, btn, key, lang, REQUEST, RESPONSE=None): (source) ¶

Create, update, delete, import, export, or invite managed users.

Parameters
btn:`str`	Action button id
key:`str`	Edited object type selector
lang:`str`	UI language id
REQUEST	Zope request object
RESPONSE	Optional Zope response object

def purgeLocalUsers(self, ob=None, valid_userids=[], invalid_userids=[]): (source) ¶

Remove stale local user assignments from a subtree.

Parameters
ob	Start object for traversal
valid_userids:`list`	Cache of known valid user ids
invalid_userids:`list`	Cache of known invalid user ids
Returns
`str`	HTML status report

def searchUsers(self, search_term=''): (source) ¶

Search the underlying user folder for matching users.

Parameters
search_term:`str`	Search string
Returns
`list`	Matching user ids or logins

def setLocalUser(self, id, node, roles, langs): (source) ¶

Assign a local user definition to a node and set local roles.

Parameters
id:`str`	User id
node:`str`	Node reference path
roles:`list`	Role ids
langs:`list`	Language ids

def setUserAttr(self, user, name, value): (source) ¶

Persist a user attribute in the central security configuration.

Parameters
user	User reference
name:`str`	Attribute name
value	Attribute value

def toggleUserActive(self, id): (source) ¶

Apply or remove local roles depending on the user's active state.

Parameters
id:`str`	User id

manage_users = (source) ¶

Undocumented

manage_users_sitemap = (source) ¶

Undocumented