mirror of
https://github.com/goauthentik/authentik
synced 2026-04-28 10:28:22 +02:00
6ed5cb5249
* website/integrations: rename "Create with Provider" to "New Application" The application list page now uses a split-button labeled "New Application" instead of the old "Create with Provider" dropdown. Update all 113 integration guides to match. * website/docs: update flow, stage, and policy button labels - "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons - "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit - "Create and bind stage" → "New Stage" / "Bind Existing Stage" - "Create" (binding submit) → "Create Stage Binding" * website/docs: update provider button labels - "Create" → "New Provider" for trigger buttons - "Create with Provider" → "New Application" in RAC docs - "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt" for related entity creation * website/docs: update directory button labels - "Create" → "New Source" for federation/social login pages - "Create" → "New Role", submit → "Create Role" - "Create" → "New Invitation" - Policy binding submit → "Create Policy Binding" * website/docs: update endpoint device and system management button labels - "Create" → "New Endpoint Connector", "New Enrollment Token", "New Device Access Group", "New Flow" - Submit → "Create Device Access Group" - "Create" → "New Notification Rule", "New Notification Transport" - Binding submit → "Create Policy Binding" * Reorganize policy documentation * website/docs: address policy docs review feedback * post-rebase * website/docs: Reorganize policy documentation -- Revisions (#21601) * apply suggestions * Fix escaped. * Fix whitespace. * Update button label. * Fix phrasing. * Fix phrasing. * Clean up stragglers. * Format. --------- Co-authored-by: Dominic R <dominic@sdko.org>
72 lines
3.1 KiB
Markdown
72 lines
3.1 KiB
Markdown
---
|
|
title: Integrate with Omni
|
|
sidebar_label: Omni
|
|
support_level: community
|
|
---
|
|
|
|
## What is Omni
|
|
|
|
> Omni manages Kubernetes on bare metal, virtual machines, or in a cloud.
|
|
>
|
|
> -- https://github.com/siderolabs/omni
|
|
|
|
## Preparation
|
|
|
|
The following placeholders are used in this guide:
|
|
|
|
- `omni.company` is the FQDN of the Omni installation.
|
|
- `authentik.company` is the FQDN of the authentik installation.
|
|
|
|
:::info
|
|
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.
|
|
:::
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Omni with authentik, you need to create a property mapping and application/provider pair in authentik.
|
|
|
|
### Create a Property Mapping, Application, and Provider in authentik
|
|
|
|
1. Log in to authentik as an administrator and open the authentik Admin interface.
|
|
2. Navigate to **Customization** > **Property Mappings** and click **Create** to create a property mapping.
|
|
|
|
- **Choose a Property Mapping type**: Select SAML Provider Property Mapping as the property mapping type.
|
|
|
|
- **Configure the Property Mapping**:
|
|
- **Name**: `*property_mapping_name*` (e.g. `Omni Mapping`)
|
|
- **SAML Attribute Name**: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`
|
|
- **Expression**: `return request.user.email`
|
|
|
|
3. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
|
|
|
|
- **Application**: provide a descriptive name, application slug, an optional group for the type of application, the policy engine mode, and optional UI settings.
|
|
|
|
- **Choose a Provider type**: select SAML Provider as the provider type.
|
|
|
|
- **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
|
|
- **ACS URL**: `https://omni.company/saml/acs`
|
|
- **Service Provider Binding**: `Post`
|
|
- **Audience**: `https://omni.company/saml/metadata`
|
|
- **Signing Certificate**: select a signing certificate, either the `authentik Self-signed Certificate` or generate a certificate via **System** > **Certificate**
|
|
- **Sign assertions**: `true`
|
|
- **Sign responses**: `true`
|
|
- **Property mappings**: `*property_mapping_name*` (e.g. `Omni Mapping`)
|
|
- **NameID Property Mapping**: `*property_mapping_name*` (e.g. `Omni Mapping`)
|
|
|
|
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/bindings-overview/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.
|
|
|
|
4. Click **Submit** to save the new application and provider.
|
|
|
|
## Omni configuration
|
|
|
|
Add the following environment variables to your Omni configuration, replacing the placeholders with your authentik FQDN and the application slug from the previous section.
|
|
|
|
```shell
|
|
auth-saml-enabled=true
|
|
auth-saml-url=https://authentik.company/application/saml/<application_slug>/metadata/
|
|
```
|
|
|
|
## Configuration verification
|
|
|
|
To confirm that authentik is properly configured with Omni, log out and log back in via the SAML button.
|