logs Package¶
logs
Module¶
models
Module¶
-
class
lemur.logs.models.
Log
(**kwargs) Bases:
sqlalchemy.ext.declarative.api.Model
-
certificate
-
certificate_id
-
id
-
log_type
-
logged_at
-
user
-
user_id
-
schemas
Module¶
-
class
lemur.logs.schemas.
LogOutputSchema
(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False) Bases:
lemur.common.schema.LemurOutputSchema
-
opts
= <marshmallow.schema.SchemaOpts object>
-
service
Module¶
-
lemur.logs.service.
audit_log
(action, entity, message) Logs given action :param action: The action being logged e.g. assign_role, create_role etc :param entity: The entity undergoing the action e.g. name of the role :param message: Additional info e.g. Role being assigned to user X :return:
-
lemur.logs.service.
create
(user, type, certificate=None) Creates logs a given action.
- Parameters
user –
type –
certificate –
- Returns
-
lemur.logs.service.
get_all
() Retrieve all logs from the database.
- Returns
-
lemur.logs.service.
render
(args) Helper that paginates and filters data when requested through the REST Api
- Parameters
args –
- Returns
views
Module¶
-
class
lemur.logs.views.
LogsList
Bases:
lemur.auth.service.AuthenticatedResource
Defines the ‘logs’ endpoint
-
endpoint
= 'logs'
-
get
() -
GET
/logs
¶ The current log list
Example request:
GET /logs HTTP/1.1 Host: example.com Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: text/javascript { "items": [ ] "total": 2 }
- Query Parameters
sortBy – field to sort on
sortDir – asc or desc
page – int default is 1
filter – key value pair format is k;v
count – count number default is 10
- Request Headers
Authorization – OAuth token to authenticate
- Status Codes
200 OK – no error
-
-
mediatypes
()
-
methods
= {'GET'} A list of methods this view can handle.
-