Identity API

Flask application to enable a REST API server 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).
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Testing
• Documentation
• Usage
  • Running the template service
  • Upgrading Gradle Wrapper
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Flask application to enable a REST API server 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).

Includes three main paths:

• Resources - CRUD operations to manage resources
• Policies - CRUD operations to manage policies
• Permissions - CRUD operations to manage permissions

Built With

• Python
• PyTest
• YAML
• Travis CI

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Docker
• Python

Installation

1. Get into EOEPCA's development environment

vagrant ssh

3. Clone the repo

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

4. Change local directory

cd um-identity-api

5. Execute

   5.1 Run locally with Python

   pip install -r requirements.local.txt
   python -m "flask" run --host=0.0.0.0 --port=5566

   5.2 Run locally with Docker

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

   5.3 Run develop branch with Docker

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

   5.4 Run master branch with Docker

   docker run --rm -dp 5566:5566 --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

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

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.