Omni Documentation
Try OmniTalos Linux
  • Omni Documentation
  • Omni Support Matrix
  • Tutorials
    • Getting Started with Omni
    • Upgrading Omni Clusters
    • Installing Airgapped Omni
    • Using SAML and ACLs for fine-grained access control
    • Setting Up the Bare-Metal Infrastructure Provider
  • How-to guides
    • Using SAML with Omni
      • Add a User to Omni with SAML Enabled
      • Auto-assign roles to SAML users
      • Configure Workspace ONE Access for Omni
      • Configure Okta for Omni
      • Configure Entra ID AD for Omni
      • Configure Unifi Identity Enterprise for Omni
    • Register machines with Omni
      • Register a Bare Metal Machine (ISO)
      • Register a Bare Metal Machine (PXE/iPXE)
      • Register an AWS EC2 Instance
      • Register an Azure Instance
      • Register a GCP Instance
      • Register a Hetzner Server
    • Create a Cluster
    • Install talosctl
    • Install and Configure Omnictl
    • Use Kubectl With Omni
    • Create a Kubeconfig for a Kubernetes Service Account
    • Create a Patch For Cluster Machines
    • Manage Access Policies (ACLs)
    • Create a Hybrid Cluster
    • Run Omni on your own infrastructure
      • Deploy Omni On-prem
      • Configure Keycloak for Omni
      • Back Up On-prem Omni Database
      • How to expose Omni with Nginx (HTTPS)
    • Install Talos Linux Extensions
    • Scale a Cluster Up or Down
    • Etcd backups
    • Restore Etcd of a Cluster Managed by Cluster Templates
    • Create an Omni Service Account
    • Create a Machine Class
    • Expose an HTTP Service from a Cluster
    • Export a Cluster Template from a Cluster Created in the UI
    • Audit logs
    • Set Initial Machine Labels Using Omnictl or Image Factory
  • Explanation
    • Machine Registration
    • Authentication and Authorization
    • Omni KMS Disk Encryption
    • Infrastructure Providers
  • Reference
    • omnictl CLI
    • Access Policies (ACLs)
    • Generating omnictl CLI reference
    • Cluster Templates
Powered by GitBook
On this page
Edit on GitHub
Export as PDF
  1. How-to guides
  2. Using SAML with Omni

Configure Workspace ONE Access for Omni

How to configure VMware Workspace ONE Access for Omni using SAML.

PreviousAuto-assign roles to SAML usersNextConfigure Okta for Omni

Last updated 9 months ago

Workspace ONE Access

This section describes how to create a Web App inside Workspace ONE Acces (WSOA).

First, login to the WSOA user interface and browse to Resources -> Web Apps -> New

Next, enter values for the following options before clicking on Next.

Option
Value
Description

Name

Omni

A descriptive name for the Web App

Description

Sidero Omni

A description for the Web App

Icon

Image

An icon to be displayed on the dashboard

On the Single Sign-On page, enter the following values:

Option
Value
Description

Authentication Type

SAML 2.0

The Authentication type. Options are SAML or OIDC

Configuration

Manual

We will use manual to specify the fields

Single Sign-On URL

https://{omni-host}/saml/acs

The SSO URL for Omni

Recipient URL

https://{omni-host}/saml/acs

The Recipient URL for Omni

Application ID

https://{omni-host}/saml/metadata

The Omni metadata URL

Username format

Unspecified

The username format is unspecified

Username value

${user.userName}

The username sent in the SAML assertion

Relay State URL

Blank

Leave this empty

Still on the Single Sign-On page, in the Advanced Properties section, set the following toggle buttons;

Option
Value
Description

Sign Response

False

Sign the SAML response.

Sign Assertion

True

Sign the SAML assertion.

Encrypt Assertion

False

Encrypt the SAML assertion.

Include Assertion Signature

False

Include the assertion signature.

Device SSO Response

False

Enable Device SSO response.

Enable Force Authn Request

False

Enable Force Authn Request.

Signature Algorithm

SHA-256 with RSA

The signature algorithm.

Digest Algorithm

SHA-256

The digest algorithm.

Assertion Lifetime

200

The assertion lifetime.

At the bottom of the Single Sign-On page, in the Custom Attribute Mapping section, add the following attributes:

Name
Format
Namespace
Value
Description

email

Unspecified

${user.email}

The user’s email address

firstName

Unspecified

${user.firstName}

The user’s first name

lastName

Unspecified

${user.lastName}

The user’s last name

groups

Unspecified

${groupNames}

The user’s groups

Click Next to continue and select the access policy as required by your organization.

Now it’s time to click the Save & Assign button and permit the Users and Groups allowed to login to Omni.

On the Assign screen, enter the following:

  • Select the permitted group from your backing Active Directory or LDAP server.

  • Set the Deployment Type to Automatic.

Finally, obtain the IdP Metadata URL by clicking on Settings and then the Copy URL link.

This is the URL that will be used by Omni in the command line arguments in the next section.

Omni

Provide the following flags to the Omni container on launch.

Flag
Description

--auth-saml-enabled

Enable SAML authentication.

--auth-saml-url

The URL to the IdP metadata file.

--auth-saml-label-rules='{"groups": "groups"}'

This extracts the groups attribute from the SAML assertion into the label saml.omni.sidero.dev/groups/<value>

For example;

Copy

--auth-saml-enabled=true
--auth-saml-url=https://{workspace-one-host}/SAAS/API/1.0/GET/metadata/idp.xml
--auth-saml-label-rules='{"groups": "groups"}'

Note that when using groups, the group name is prefixed with saml.omni.sidero.dev/groups/ instead of role. For example;

Copy

metadata:
  namespace: default
  type: SAMLLabelRules.omni.sidero.dev
  id: assign-admin-to-platform-admins-label
spec:
  assignroleonregistration: Operator
  matchlabels:
    - saml.omni.sidero.dev/groups/omni-platform-administrators

Now that you have started Omni with the correct flags, refer to the guide for information on how to automatically assign roles to users based on their SAML attributes.

Auto-assign roles to SAML users