EOEPCA / um-identity-api

Identity API

FastAPI application exposing a Restful API to manage Keycloak through Keycloak Admin API (https://www.keycloak.org/docs-api/22.0.1/rest-api/index.html) and Protection API (https://www.keycloak.org/docs/latest/authorization_services/index.html#_service_protection_api).
Explore the docs »
· Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Documentation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

FastAPI application exposing a Restful API to manage Keycloak through Keycloak Admin API (https://www.keycloak.org/docs-api/21.0.1/rest-api/index.html) and Protection API (https://www.keycloak.org/docs/latest/authorization_services/index.html#_service_protection_api).

Swagger docs are available at /docs.
Redoc docs are available at /redoc.

Built With

• Python
• FastAPI

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Docker
  or
• Docker compose
  or
• Python

Installation

1. Clone the repo

git clone https://github.com/EOEPCA/um-identity-api

2. Change local directory

cd um-identity-api

3. Execute

   3.1 Run with docker compose (Identity API + Keycloak + Postgres)

   docker compose up -d --build

   3.2 Run with Python

   pip install -r requirements.txt
   uvicorn app.main:app

   3.3 Run with Docker

   docker build . --progress=plain -t um-identity-api:local
   docker run --rm -dp 8080:8080 --name um-identity-api um-identity-api:local

   3.4 Run develop branch with Docker

   docker run --rm -dp 8080:8080 --name um-identity-api ghcr.io/eoepca/um-identity-api:develop

   3.5 Run master branch with Docker

   docker run --rm -dp 8080:8080 --name um-identity-api ghcr.io/eoepca/um-identity-api:production

Documentation

The component documentation can be found at https://eoepca.github.io/um-identity-api/.

Usage

Check Redoc page to try out the API, available at http://localhost:8080/redoc

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

EOEPCA mailbox

Project Link: https://github.com/EOEPCA/um-identity-api

Acknowledgements

• README.md is based on this template by Othneil Drew.