Skip to main content

Identity Providers

Identity providers allow users to authenticate with OctoMesh using external identity systems such as Google, Microsoft, Azure Entra ID, LDAP, or Active Directory. Each tenant configures its own set of providers independently.

note

The Identity Providers page requires the TenantManagement role. It is only visible in the sidebar if you have this role assigned.

Accessing Identity Providers

Navigate to Identity > Identity Providers to access the provider management interface.

The list shows all configured identity providers:

ColumnDescription
NameDisplay name of the provider
TypeProvider type (e.g., Google, Azure Entra ID, OpenLDAP)
EnabledWhether the provider is active
DescriptionOptional description

Toolbar Actions

ButtonDescription
New ProviderConfigure a new identity provider
SearchFilter providers by name or type
Export to ExcelExport the provider list to an Excel file
Export to PDFExport the provider list to a PDF file
Refresh DataReload the provider list

Row and Context Actions

ActionDescription
EditOpen the provider in the edit form
DeleteDelete the provider (context menu, with confirmation)

Creating an Identity Provider

Click New Provider to open the provider creation form.

Provider Type

First, select the provider type from the dropdown. The form dynamically shows the relevant configuration fields based on the selected type.

TypeDescription
GoogleGoogle OAuth 2.0 authentication
MicrosoftMicrosoft Account OAuth 2.0 authentication
FacebookFacebook OAuth 2.0 authentication
Azure Entra IDCorporate Azure AD / Entra ID authentication
OpenLDAPLDAP directory authentication
Active DirectoryMicrosoft Active Directory (LDAPS)
OctoTenantCross-tenant authentication via a parent tenant

General Information

These fields are shown for all provider types:

FieldRequiredDescription
NameYesDisplay name for the provider (shown on the login page)
DescriptionNoOptional description
EnabledWhether the provider is active (checkbox)

Login Configuration

These options control how new users are handled:

FieldDescription
Allow Self-RegistrationWhen enabled, users who authenticate via this provider are automatically registered in the tenant on first login. When disabled, users must be pre-created by an administrator.
Default GroupWhen set, new users from this provider are automatically added to the selected group, inheriting all of its roles.
tip

Use the Default Group setting to automatically grant a baseline set of permissions to all users from a specific provider. For example, set it to a "Viewers" group so all new users can immediately view dashboards.

OAuth Configuration (Google, Microsoft, Facebook, Azure Entra ID)

FieldRequiredDescription
Client IDYesOAuth client ID from the provider's developer console
Client SecretYesOAuth client secret from the provider's developer console
info

In edit mode, the client secret is not displayed (it is stored encrypted). Click Set New Secret to replace it.

Azure Entra ID Configuration

Shown in addition to the OAuth fields when Azure Entra ID is selected:

FieldRequiredDescription
Tenant IDYesAzure AD tenant ID (directory ID)
AuthorityNoAuthority URL (defaults to https://login.microsoftonline.com)

Directory Server Configuration (OpenLDAP, Active Directory)

FieldRequiredDescription
HostYesLDAP server hostname or IP address
PortYesLDAP server port (typically 636 for LDAPS)
Use TLSEnable TLS encryption (checkbox)

User Configuration (OpenLDAP only)

FieldRequiredDescription
User Base DNYesBase Distinguished Name for user searches (e.g., ou=users,dc=example,dc=com)
User Name AttributeYesLDAP attribute used as the username (e.g., uid)

OctoTenant Configuration

FieldRequiredDescription
Parent Tenant IDYesThe tenant ID of the parent tenant to authenticate against
info

The OctoTenant provider delegates authentication to a parent tenant. Users from the parent tenant can then log into this tenant using their existing credentials. See the Cross-Tenant Authentication technology guide for details.

Click Save to create the provider or Cancel to discard.

Editing an Identity Provider

Click Edit on a provider row to open the edit form. The provider type cannot be changed after creation. All other fields can be modified.

Deleting an Identity Provider

Right-click a provider and select Delete. Confirm the deletion in the dialog.

danger

Deleting an identity provider prevents all users who rely on it from logging in. Users who have only registered via this provider will no longer be able to authenticate. Make sure to provide an alternative authentication method before deleting a provider.

Default Identity Providers

The system tenant is automatically configured with two default identity providers:

ProviderTypeEnabled
GoogleGoogle OAuth 2.0No (disabled by default)
MicrosoftMicrosoft Account OAuth 2.0No (disabled by default)

To enable them, edit the provider and supply the required Client ID and Client Secret from the respective developer consoles, then set Enabled to true.

info

Child tenants do not receive Google and Microsoft providers by default. Instead, they automatically receive an OctoTenant provider pointing to the parent tenant, enabling cross-tenant authentication. You can manually add additional providers as needed.