Skip to content

Added auditing doc section ( #56 ) #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PoffM wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added auditing doc section ( #56 ) #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions DINA-Web-API-Guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,22 @@ provide ways for external applications to authenticate before they are
authorized to make calls. The API **SHOULD** support use of OAuth 2.0 ( https://tools.ietf.org/html/rfc6749 )
athentication.

Auditing
--------

User activity and changes to data **SHOULD** be tracked using audit logs.

Tracked audit data includes:

* What data was changed: data snapshots or diffs
* When the data was changed: timestamps
* Who changed the data: user ID or username

Open-source libraries can used to implement auditing, such as:

* Javers ( https://javers.org/ )
* Hibernate Envers ( https://hibernate.org/orm/envers/ )

HTTPS
-----
All APIs must not provide HTTP public facing. HTTPS **MUST ONLY** be used in public facing APIs.
Expand Down