1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/org_admin_views.py.md

75 lines
1.6 KiB
Markdown
Raw Normal View History

Generated from org_admin_views.py on 2022-04-12 16:41:02.631987
# peeringdb_server.org_admin_views
View for organization administrative actions (/org endpoint).
# Functions
---
## extract_permission_id
`def extract_permission_id(source, dest, entity, org)`
Extract a user's permissioning id for the specified
entity from source <dict> and store it in dest <dict>.
Source should be a dict containing django-namespace-perms
(namespace, level) items.
Dest should be a dict where permission ids are to be
exracted to.
Entity can either be a HandleRef instance or class.
Org must be an Organization instance that owns the
entity.
---
## load_all_user_permissions
`def load_all_user_permissions(org)`
Return dict of all users with all their permissions for
the given org.
---
## load_entity_permissions
`def load_entity_permissions(org, entity)`
Return entity's permissions for the specified org.
---
## org_admin_required
`def org_admin_required(fnc)`
Decorator function that ensures that the requesting user
has administrative rights to the targeted organization.
Also sets "org" in kwargs.
---
## permission_ids
`def permission_ids(org)`
Return a dict of a valid permissioning ids for
the specified organization.
---
## save_user_permissions
`def save_user_permissions(org, user, perms)`
Save user permissions for the specified org and user.
Perms should be a dict of permissioning ids and permission levels.
---
## target_user_validate
`def target_user_validate(fnc)`
Decorator function that ensures that the targeted user
is a member of the targeted organization.
Should be below org_admin_required.
Also sets "user" in kwargs.
---