{"id":33077436,"url":"https://github.com/zak905/keycloak-api-key-demo","last_synced_at":"2026-04-03T17:01:36.374Z","repository":{"id":41784886,"uuid":"192325332","full_name":"zak905/keycloak-api-key-demo","owner":"zak905","description":"Demonstration on how to add an API key authentication feature to keycloak","archived":false,"fork":false,"pushed_at":"2026-03-01T22:05:04.000Z","size":92,"stargazers_count":151,"open_issues_count":5,"forks_count":28,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-03-02T01:33:26.669Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zak905.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-06-17T10:27:25.000Z","updated_at":"2026-03-01T16:13:51.000Z","dependencies_parsed_at":"2024-01-01T23:17:43.918Z","dependency_job_id":"329cf275-bcd9-4763-b81e-8b1147c1f8c5","html_url":"https://github.com/zak905/keycloak-api-key-demo","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/zak905/keycloak-api-key-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zak905%2Fkeycloak-api-key-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zak905%2Fkeycloak-api-key-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zak905%2Fkeycloak-api-key-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zak905%2Fkeycloak-api-key-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zak905","download_url":"https://codeload.github.com/zak905/keycloak-api-key-demo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zak905%2Fkeycloak-api-key-demo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31364582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T15:19:21.178Z","status":"ssl_error","status_checked_at":"2026-04-03T15:19:20.670Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-11-14T11:00:29.138Z","updated_at":"2026-04-03T17:01:35.972Z","avatar_url":"https://github.com/zak905.png","language":"Java","funding_links":[],"categories":["Example Projects"],"sub_categories":[],"readme":"# Keycloak extension for API key authentication\n\nThe extension contains providers for supporting API key authentication, and also other non related providers like a custom `EmailSenderProvider` (for demo purposes).\n\nIt also contains a customization of the account console (the user info page provided by Keycloak) showing the API key. The account console is accessible at `/auth/realms/{realm_name}/account` and requires the user to be already authenticated.  \n\nThe master branch uses the new Keycloak distribution powered by Quarkus. For Legacy keycloak (versions \u003c 17.0.0), you can switch to the `legacy` branch. \n## How to run \n\nyou can run the project by running the following from a terminal: `mvn -f api-key-module package \u0026\u0026 mvn -f dashboard-service package \u0026\u0026 docker-compose up`\n\nNote: You need to add `auth-server` to your hosts file (`/etc/hosts` for linux) and map it to localhost.\n\n## Testing\n\n1. Navigate to localhost:8180 in a browser, you will redirected to keycloak for authentication\n2. you need register a new user, after which you will be redirected to the main dashboard page which will show your API key\n3. copy the API key and use it to call the API: `curl -v -H \"x-api-key: $THE_API_KEY\" localhost:8280`, if you omit the API key, you will get 401 status\n\nMore explanations can be found in this blog [post](http://www.zakariaamine.com/2019-06-14/extending-keycloak)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzak905%2Fkeycloak-api-key-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzak905%2Fkeycloak-api-key-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzak905%2Fkeycloak-api-key-demo/lists"}