Skip to content
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.

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

Executable tutorial: Secure an API endpoint using Keycloak running in… #1094

Merged
merged 1 commit into from
Apr 3, 2021
Merged
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions contributions/executable-tutorial/lerjevik-wska/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Executable tutorial: Secure an API endpoint using Keycloak running in Docker

## Members
- [Dina Lerjevik](https://github.com/dmariel) (lerjevik@kth.se)
- [William Skagerström](https://github.com/wska) (wska@kth.se)

## Proposal
We would like to publish a tutorial on how to secure an API endpoint using Keycloak running in Docker and hosting it on Katacoda.

The aim of our tutorial is to:

* Provide and explain a simple API (likely a basic API using Python and Flask)
* Educate about security, Oauth2, OpenID Connect and Keycloak
* Showcase how to set up Keycloak and host it using Docker
* Go through how to set up a realm and add users with different levels of security clearance
* Use the existing Keycloak realm to secure the previously introduced API, which will now require access tokens and the relevant security clearance

We found an existing tutorial on Katacoda on this topic, however we believe that this tutorial was very basic since it merely only covers how to obtain an access token and using it for an request, which is only a few steps of the whole process.