hedgedoc/docs/content/dev/private-api-auth.md
Philip Molares d6be1cc6bb
docs: add documentation on private api authentication
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-08-08 20:21:16 +02:00

739 B

Private API Auth

Supported kinds of authentication

  • Username & Password (local)
  • LDAP
  • SAML
  • OAuth2
  • GitLab
  • GitHub
  • Facebook
  • Twitter
  • Dropbox
  • Google

How the authentication works

The backend is called directly from the frontend. The different routes that handle different kinds of authentication perform any kind of verification needed and then create a session cookie. This session cookie is than provided with each subsequent call to the private api by the frontend (until it expires or the user logs out). The SessionGuard, which is added to each other (appropriate) controller method of the private api, checks if the provided session is still valid and provides the controller method with the correct user.