Overview
What Heimdall is, what it is not, and the concepts the rest of the documentation assumes.
Documentation
What Heimdall is, how it is put together, how to run it, and how to use it.
Heimdall is an identity-management system made of two repositories: the Heimdall API, which holds the data and the rules, and Heimdall UI, a Flutter application that drives the API. This documentation covers both. It explains what Heimdall is, how it is put together, how to run it, how to use the interface, and how a client system connects to it. The API keeps its own detailed documentation, and these pages link to it rather than copy it.
| Section | What it covers |
|---|---|
| Overview | What Heimdall is, what it is not, and the concepts the rest of the documentation assumes. |
| Architecture | How the API and the UI are built, and how they talk to each other. |
| Installation | What you need and the commands to run the API and the UI. |
| User guide | How to use the interface, task by task, by role. |
| Integrating a client system | What a system that delegates its identities to Heimdall has to do. |
| API documentation | A map of the API site’s sections: what each covers and where to find it, from the endpoint reference to the data-protection documents. |
| Repositories | The repositories behind Heimdall, their releases and the specification documents. |
Architecture
How Heimdall is put together: the systems around it, the layers of the API, the structure of the UI, and how the UI decides what each role sees.
Installation
What you need, and the commands, to get a release, run the Heimdall API, run the Heimdall UI, and point the one at the other.
User guide
How to use Heimdall UI, task by task: signing in, managing your account, and administering scopes, persons, applications, permissions and Google users.
Integrating a client system
What a system that delegates its people and its sign-in to Heimdall gets, how it authenticates them, what the caller key is for, and how Fortuna does it.
API documentation
A map of the Heimdall API’s own documentation site: what each section covers and where to find it, from the endpoint reference to the data-protection documents.
Repositories
The repositories behind Heimdall, their releases, every specification document each code repository holds, and where to follow the work.