diff options
| -rw-r--r-- | src/mailman/interfaces/user.py | 3 | ||||
| -rw-r--r-- | src/mailman/rest/docs/owners.rst | 61 |
2 files changed, 64 insertions, 0 deletions
diff --git a/src/mailman/interfaces/user.py b/src/mailman/interfaces/user.py index 1068890c1..76ceb3f37 100644 --- a/src/mailman/interfaces/user.py +++ b/src/mailman/interfaces/user.py @@ -70,6 +70,9 @@ class IUser(Interface): memberships = Attribute( """A roster of this user's memberships.""") + is_server_owner = Attribute( + """Boolean flag indicating whether the user is a server owner.""") + def register(email, display_name=None): """Register the given email address and link it to this user. diff --git a/src/mailman/rest/docs/owners.rst b/src/mailman/rest/docs/owners.rst new file mode 100644 index 000000000..71f112247 --- /dev/null +++ b/src/mailman/rest/docs/owners.rst @@ -0,0 +1,61 @@ +=============== + Server owners +=============== + +Certain users can be designated as *server owners*. This role has no direct +function in the core, but it can be used by clients of the REST API to +determine additional permissions. For example, Postorius might allow server +owners to create new domains. + +Initially, there are no server owners. + + >>> dump_json('http://localhost:9001/3.0/owners') + http_etag: "..." + start: 0 + total_size: 0 + +When new users are created in the core, they do not become server owners by +default. + + >>> from zope.component import getUtility + >>> from mailman.interfaces.usermanager import IUserManager + >>> user_manager = getUtility(IUserManager) + >>> anne = user_manager.create_user('anne@example.com', 'Anne Person') + >>> transaction.commit() + >>> dump_json('http://localhost:9001/3.0/owners') + http_etag: "..." + start: 0 + total_size: 0 + +Anne's server owner flag is set. + + >>> anne.is_server_owner = True + >>> transaction.commit() + +And now we can find her user record. + + >>> dump_json('http://localhost:9001/3.0/owners') + http_etag: "..." + start: 0 + total_size: 1 + +Bart and Cate are also users, but not server owners. + + >>> bart = user_manager.create_user('bart@example.com', 'Bart Person') + >>> cate = user_manager.create_user('cate@example.com', 'Cate Person') + >>> transaction.commit() + >>> dump_json('http://localhost:9001/3.0/owners') + http_etag: "..." + start: 0 + total_size: 1 + +Anne retires as a server owner, with Bart and Cate taking over. + + >>> anne.is_server_owner = False + >>> bart.is_server_owner = True + >>> cate.is_server_owner = True + >>> transaction.commit() + >>> dump_json('http://localhost:9001/3.0/owners') + http_etag: "..." + start: 0 + total_size: 2 |