Heimdall Documentation

Heimdall is a high-performance, passwordless OpenID Connect (OIDC) authentication server designed to secure multi-tenant applications. Built in Rust and requiring MongoDB, Heimdall offers a scalable, secure, and developer-friendly solution for managing authentication in complex organizational structures. Integrate Heimdall to enable seamless, passwordless authentication for your users, teams, and organizations.

Getting Started

To begin, set up Heimdall locally using Docker to explore its features or configure it for production deployment. Follow our guides to run Heimdall, configure environment variables, and integrate it with your applications using OIDC protocols. When your integration is ready, deploy Heimdall to provide secure, passwordless authentication to your users.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Pagination

Understand how to work with paginated responses.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

Webhooks

Learn how to programmatically configure webhooks for your app.

Read more

Resources

Contacts

Learn about the contact model and how to create, retrieve, update, delete, and list contacts.

Conversations

Learn about the conversation model and how to create, retrieve, update, delete, and list conversations.

Messages

Learn about the message model and how to create, retrieve, update, delete, and list messages.

Groups

Learn about the group model and how to create, retrieve, update, delete, and list groups.

Was this page helpful?