AdminService¶
- class gafaelfawr.services.admin.AdminService(admin_store, admin_history_store, logger)¶
Bases:
object
Manage the token administrators.
- Parameters:
admin_store (
AdminStore
) – The backing store for token administrators.admin_history_store (
AdminHistoryStore
) – The backing store for history of changes to token administrators.logger (
BoundLogger
) – Logger to use for messages.
Methods Summary
add_admin
(username, *, actor, ip_address)Add a new administrator.
add_initial_admins
(admins)Add the initial admins if the database is not initialized.
delete_admin
(username, *, actor, ip_address)Delete an administrator.
Get the current administrators.
is_admin
(username)Return whether the given user is a token administrator.
Methods Documentation
- async add_admin(username, *, actor, ip_address)¶
Add a new administrator.
- Parameters:
- Raises:
DuplicateAdminError – Raised if the specified user is already an admin.
PermissionDeniedError – Raised if the actor is not an admin.
- Return type:
- async add_initial_admins(admins)¶
Add the initial admins if the database is not initialized.
This should be called after database initialization to add the configured initial admins. The admin list will only be changed if it is currently empty.
- async delete_admin(username, *, actor, ip_address)¶
Delete an administrator.
- Parameters:
- Returns:
True
if the administrator was found and deleted,False
if they were not found.- Return type:
- Raises:
PermissionDeniedError – If the actor is not an admin.