Skip to content

docs: add userRegistration and syncRolesAt #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sweb merged 1 commit into from
Jul 9, 2026
Merged

docs: add userRegistration and syncRolesAt #813

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions docs/modules/airflow/pages/usage-guide/security.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,21 @@ spec:
productVersion: 3.1.6
clusterConfig:
authentication:
- authenticationClass: ldap # <1>
userRegistrationRole: Admin # <2>
- authenticationClass: ldap # <1>
userRegistration: true # <2>
userRegistrationRole: Admin # <3>
syncRolesAt: Registration # <4>
----

<1> The reference to an AuthenticationClass called `ldap`
<2> The default role that all users are assigned to
<2> Whether users that are not yet in Airflow's user database are created automatically on their first login (defaults to `true`)
<3> The default role that all users are assigned to
<4> When user roles are synchronized with the identity provider: `Registration` (only on first login, the default) or `Login` (on every login)

Users that log in with LDAP are assigned to a default {airflow-access-control-docs}[role{external-link-icon}^] which is specified with the `userRegistrationRole` property.

TLS verification for the authentication connection cannot be disabled; the operator rejects an AuthenticationClass that turns it off.

You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass reference {external-link-icon}^].

The users and roles can be viewed as before in the Webserver UI, but the blue "+" button is not available when authenticating via LDAP:
Expand Down Expand Up @@ -77,15 +83,21 @@ spec:
- authenticationClass: keycloak # <1>
oidc:
clientCredentialsSecret: airflow-keycloak-client # <2>
userRegistrationRole: User # <3>
userRegistration: true # <3>
userRegistrationRole: User # <4>
syncRolesAt: Registration # <5>
----

<1> The reference to an AuthenticationClass called `keycloak`
<2> The reference to the Secret containing the Airflow client credentials
<3> The default role to which all users are assigned
<3> Whether users that are not yet in Airflow's user database are created automatically on their first login (defaults to `true`)
<4> The default role to which all users are assigned
<5> When user roles are synchronized with the identity provider: `Registration` (only on first login, the default) or `Login` (on every login)

Users that log in with OpenID Connect are assigned to a default {airflow-access-control-docs}[role{external-link-icon}^] which is specified with the `userRegistrationRole` property.

TLS verification for the authentication connection cannot be disabled; the operator rejects an AuthenticationClass that turns it off.

The Secret containing the Airflow client credentials:

[source,yaml]
Expand Down
Loading