The Deckhouse Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.
The module lifecycle stage: General Availability
DexAuthenticator
Short names: dex-auth
Scope: Namespaced
- v1
- v2alpha1
- v1alpha1
After the DexAuthenticator object appears in the namespace, the following objects will be created:
- Deployment containing OAuth2-Proxy and Redis containers;
- Service, pointing to OAuth2-Proxy;
- Ingress resource, configured to receive requests on
https://<applicationDomain>/dex-authenticatorand send it to a service side; - HTTPRoute resource (optional), configured to receive requests on
https://<applicationDomain>/dex-authenticatorand send it to a service side; - Secrets, needed to access Dex.
Warning. DexAuthenticator only works with HTTPS. The application Ingress must have TLS configured.
Warning. After restarting a pod with an OAuth2-Proxy, the current Access Token and ID Token will be queried (using the refresh token) and stored in a Redis memory.
The name of a DexAuthenticator must be a DNS-1035 label of at most 63 characters: it starts with a lowercase letter and contains only lowercase letters, digits and hyphens. The name is a part of the name of its Service and a label value of the objects it creates.
Examples:
apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
name: app-name
namespace: app-namespace
spec:
applicationDomain: app-name.kube.my-domain.com
sendAuthorizationHeader: false
applicationIngressCertificateSecretName: ingress-tls
applicationIngressClassName: nginx
keepUsersLoggedInFor: 720h
allowedGroups:
- everyone
- admins
allowedProviders:
- local
- corp-ldap
whitelistSourceRanges:
- 1.1.1.1/32
- 192.168.0.0/24
additionalApplications:
- domain: additional-app-name.kube.my-domain.com
ingressSecretName: ingress-tls
ingressClassName: nginx
signOutURL: "/logout"
whitelistSourceRanges:
- 2.2.2.2/32
apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
name: app-alb
namespace: app-namespace
spec:
applicationDomain: app.example.com
gatewayAPI:
applicationHTTPRouteListenerSetName: app-listeners
- objectmetadata
- stringmetadata.name
Maximum length:
63
- objectspec
Required value
- array of objectsspec.additionalApplications
A list of additional applications for which user authentication is required.
- stringspec.additionalApplications.domain
Required value
An application domain from which the user request will be redirected for authentication in Dex.
Warning. Specify a DNS name that complies with RFC 1123 (subdomain) and does not include an HTTP scheme. IP addresses are not allowed.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - objectspec.additionalApplications.gatewayAPI
A set of parameters to use in HTTPRoute object.
Warning. Only applicable in clusters with Gateway API support.
Warning. Define the same ListenerSet object which is used to publish the application domain.
- stringspec.additionalApplications.gatewayAPI.httpRouteListenerSetName
Required value
Name of the ListenerSet object from the Gateway API to be referred to from the HTTPRoute.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
httpRouteListenerSetName: default-listener-set - stringspec.additionalApplications.gatewayAPI.httpRouteListenerSetNamespace
Namespace where the ListenerSet object from the Gateway API is deployed to be referred to from the HTTPRoute.
If not set, the namespace of the
DexAuthenticatoris used.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
63Example:
httpRouteListenerSetNamespace: default - stringspec.additionalApplications.gatewayAPI.httpRouteListenerSetSectionName
Section name from the ListenerSet object in the Gateway API the HTTPRoute refers to.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
httpRouteListenerSetSectionName: web-listener
- stringspec.additionalApplications.ingressClassName
The name of the Ingress class to be used in the Ingress resource (it must match the Ingress class name for the application domain).
Required unless
gatewayAPIis specified. If omitted, no Ingress resources are created for this application. Both fields may be specified.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - stringspec.additionalApplications.ingressSecretName
The name of the Secret containing the TLS certificate (from the domain) used in the applications Ingress resource. The Secret must be in the same namespace as DexAuthenticator.
Pattern:
^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$ - stringspec.additionalApplications.signOutURL
The URL of the application from which requests will be redirected to the sign-out URL of the
dex-authenticator.It is used in the application to direct logout requests. A separate Ingress resource will be created for the specified URL, and requests to it will be redirected to
dex-authenticator.The value must not contain line breaks.
Pattern:
^[^\r\n]*$Maximum length:
2048 - array of stringsspec.additionalApplications.whitelistSourceRanges
CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.
Example:
whitelistSourceRanges: - 192.168.42.0/24- stringElement of the array
Pattern:
^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$
- array of stringsspec.allowedEmails
A list of emails of users are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose email is no longer listed.
By default, all users can connect.
Values must not contain line breaks.
Default:
All emails are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
320
- array of stringsspec.allowedGroups
A list of groups whose members are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose stored groups no longer intersect it.
By default, all groups can connect.
Values must not contain line breaks.
Default:
All groups are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
512
- array of stringsspec.allowedProviders
Names of the DexProvider objects through which users can sign in to the application.
Use
localfor the users of the built-in password database (User).Checked on the sign-in page, on login, and on every refresh-token and token-exchange request. A provider outside the list is not offered on the sign-in page. If the list holds one provider, users go straight to it. Removing a provider from the list stops the refresh tokens that were issued through it.
A name that matches no DexProvider is accepted with a warning. Nobody can sign in through it until the provider appears.
By default, all providers can be used.
Default:
All providers are allowed.- stringElement of the array
Pattern:
^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$Maximum length:
253
- stringspec.applicationDomain
Required value
An address for the application (DNS domain for Ingress resource) from which the user request will be redirected for authentication in Dex.
Warning. Specify a DNS name that complies with RFC 1123 (subdomain) and does not include an HTTP scheme. IP addresses are not allowed.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Example:
applicationDomain: my-app.domain.com - stringspec.applicationIngressCertificateSecretName
The name of the Secret containing the TLS certificate for the application domain (is used in the Ingress resource). The Secret must be located in the same namespace as the DexAuthenticator.
Pattern:
^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$Example:
applicationIngressCertificateSecretName: ingress-tls - stringspec.applicationIngressClassName
The name of the Ingress class to be used in the Ingress resource (it must match the Ingress class name for the application domain).
Required unless
gatewayAPIis specified. If omitted, no Ingress resources are created for this application. Both fields may be specified.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Example:
applicationIngressClassName: nginx - objectspec.gatewayAPI
A set of parameters to use in HTTPRoute object.
Warning. Only applicable in clusters with Gateway API support.
Warning. Define the same ListenerSet object which is used to publish the application domain.
- stringspec.gatewayAPI.applicationHTTPRouteListenerSetName
Required value
Name of the ListenerSet object from the Gateway API to be referred to from the HTTPRoute.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
applicationHTTPRouteListenerSetName: default-listenerset - stringspec.gatewayAPI.applicationHTTPRouteListenerSetNamespace
Namespace where the ListenerSet object from the Gateway API is deployed to be referred to from the HTTPRoute.
If not set, the namespace of the
DexAuthenticatoris used.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
63Example:
applicationHTTPRouteListenerSetNamespace: default - stringspec.gatewayAPI.applicationHTTPRouteListenerSetSectionName
Section name from the ListenerSet object in the Gateway API the HTTPRoute refers to.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
applicationHTTPRouteListenerSetSectionName: default-listener
- booleanspec.highAvailability
Enables high availability mode for
dex-authenticator.When this mode is enabled, multiple pod replicas will be deployed to ensure fault tolerance.
Default:
false - stringspec.keepUsersLoggedInFor
Maximum period of user inactivity during which the user session remains active.
Set as a string of whole hours, minutes, and seconds, in this order:
30m,20s,2h30m10s,24h.Specified value can’t be shorter or equal to the
idTokenTTLvalue set in the module settings. If you set a value that is shorter or equal toidTokenTTL, the effective logout time will beidTokenTTL + 1s.To force logout sooner than the default
idTokenTTL, decrease theidTokenTTLparameter value in the module settings as well.Default:
168hPattern:
^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$Example:
keepUsersLoggedInFor: 24h - objectspec.nodeSelector
If specified, the
dex-authenticatorpods nodeSelector.Format: the standard
nodeSelectorlist. Instance pods inherit this field as is. - objectspec.podMetadata
Additional labels and annotations for
dex-authenticatorpods.- objectspec.podMetadata.annotations
Additional annotations for
dex-authenticatorpods. - objectspec.podMetadata.labels
Additional labels for
dex-authenticatorpods.
- objectspec.resources
Container resources (CPU/memory) — requests/limits.
If this field is set, the specified values are applied and VPA is disabled for this instance. If the field is not set, behavior remains the same: when the VPA module is enabled, resources are managed by VPA, when it is disabled, default values are used.
Resources can be specified either directly for the
dex-authenticatorcontainer (for backward compatibility) or in nested objects — separately for each container.- objectspec.resources.limits
Upper limit of resources for the
dex-authenticatorcontainer (CPU/memory). This field is kept for backward compatibility. - objectspec.resources.redis
Resources of the
rediscontainer (CPU/memory) — requests/limits.- objectspec.resources.redis.limits
Upper limit of resources for the
rediscontainer (CPU/memory) - objectspec.resources.redis.requests
Guaranteed minimum resources for the
rediscontainer (CPU/memory).
- objectspec.resources.requests
Guaranteed minimum resources for the
dex-authenticatorcontainer (CPU/memory). This field is kept for backward compatibility.
- boolean
Request to application will be sent with
Authorization: Bearerheader when the option is switched to true.When enabled, the header carries a signed Dex ID token (
id_token) containing the user’s email, name, and group membership. This is the only way to pass the user’s groups to the application via DexAuthenticator: a separateX-Auth-Request-Groupsheader with groups is not sent.Warning. Enable it only if the application can process this header.
When setting
sendAuthorizationHeader: true, list all necessary headers in the application’s Ingress resource (if the application is published through an Ingress) or in the HTTPRoute resource (if the application is published through an ALBInstance or ClusterALBInstance of thealbmodule).Also, if the application is published through an Ingress resource, when setting
sendAuthorizationHeader: true, increase the header buffer size, since a JWT with many groups may not fit into the default buffer.For details on specifying the headers and increasing the buffer, see How to pass the user’s login and groups to an application.
- stringspec.signOutURL
The URL of the application from which requests will be redirected to the sign-out URL of the
dex-authenticator.It is used in the application to direct logout requests. A separate Ingress resource will be created for the specified URL, and requests to it will be redirected to
dex-authenticator.The value must not contain line breaks.
Pattern:
^[^\r\n]*$Maximum length:
2048 - array of objectsspec.tolerations
If specified the
dex-authenticatorpods tolerations.Format: the standard toleration list. Instance pods inherit this field as is.
- stringspec.tolerations.effect
Defines the taint’s effect this toleration is associated with (it matches any effect if empty).
Allowed values:
NoSchedule,PreferNoSchedule,NoExecute - stringspec.tolerations.key
Defines the taint’s key this toleration is associated with (it matches any key if empty).
If the key is omitted (empty), then
operatormust be set toExists(which means it matches anyvalueandkey). - stringspec.tolerations.operator
Defines how the key and its value are linked — whether the key must be
Equalto the value or can have any value.Setting it to
Existsis equivalent to the value having any value so that the pod with the specified toleration can match the corresponding taint.Default:
EqualAllowed values:
Exists,Equal - integerspec.tolerations.tolerationSeconds
Specifies the period (in seconds) that the scheduler waits before evicting a Pod from a node if the toleration no longer matches the taint (only applicable to the
NoExecuteeffect, otherwise ignored).If the parameter is not set, the Pod will not be evicted from the node if the toleration no longer matches the taint. If the parameter is set to zero (or negative), the Pod will be evicted immediately if the toleration no longer matches the taint.
The default is: not set.
- stringspec.tolerations.value
The value that the toleration must match.
Must be empty if the
operatorparameter is set toExists.
- array of stringsspec.whitelistSourceRanges
CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.
Example:
whitelistSourceRanges: - 192.168.42.0/24- stringElement of the array
Pattern:
^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$
- objectmetadata
- stringmetadata.name
Maximum length:
63
- objectspec
Required value
- array of stringsspec.allowedEmails
A list of emails of users are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose email is no longer listed.
By default, all users can connect.
Values must not contain line breaks.
Default:
All users are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
320
- array of stringsspec.allowedGroups
A list of groups whose members are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose stored groups no longer intersect it.
By default, all groups can connect.
Values must not contain line breaks.
Default:
All groups are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
512
- array of stringsspec.allowedProviders
Names of the DexProvider objects through which users can sign in to the application.
Use
localfor the users of the built-in password database (User).Checked on the sign-in page, on login, and on every refresh-token and token-exchange request. A provider outside the list is not offered on the sign-in page. If the list holds one provider, users go straight to it. Removing a provider from the list stops the refresh tokens that were issued through it.
A name that matches no DexProvider is accepted with a warning. Nobody can sign in through it until the provider appears.
By default, all providers can be used.
Default:
All providers are allowed.- stringElement of the array
Pattern:
^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$Maximum length:
253
- array of objectsspec.applications
Required value
A list of applications for which user authentication is required.
- stringspec.applications.domain
Required value
An application domain (for Ingress resources) from which the user request will be redirected for authentication in Dex.
Warning. Specify a DNS name that complies with RFC 1123 (subdomain) and does not include an HTTP scheme. IP addresses are not allowed.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - objectspec.applications.gatewayAPI
A set of parameters to use in HTTPRoute object.
Warning. Only applicable in clusters with Gateway API support.
Warning. Define the same ListenerSet object which is used to publish the application domain.
- stringspec.applications.gatewayAPI.httpRouteListenerSetName
Required value
Name of the ListenerSet object from the Gateway API to be referred to from the HTTPRoute.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
httpRouteListenerSetName: default-listener-set - stringspec.applications.gatewayAPI.httpRouteListenerSetNamespace
Namespace where the ListenerSet object from the Gateway API is deployed to be referred to from the HTTPRoute.
If not set, the namespace of the
DexAuthenticatoris used.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
63Example:
httpRouteListenerSetNamespace: default - stringspec.applications.gatewayAPI.httpRouteListenerSetSectionName
Section name from the ListenerSet object in the Gateway API the HTTPRoute refers to.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
httpRouteListenerSetSectionName: web-listener
- stringspec.applications.ingressClassName
The name of the Ingress class to be used in the Ingress resource (it must match the Ingress class name for the application domain).
Required unless
gatewayAPIis specified. If omitted, no Ingress resources are created for this application. Both fields may be specified.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - stringspec.applications.ingressSecretName
The name of the Secret containing the TLS certificate for the application domain (is used in the Ingress resource). The Secret must be located in the same namespace as the DexAuthenticator.
Pattern:
^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$ - stringspec.applications.signOutURL
The URL of the application from which requests will be redirected to the sign-out URL of the
dex-authenticator.It is used in the application to direct logout requests. A separate Ingress resource will be created for the specified URL, and requests to it will be redirected to
dex-authenticator.The value must not contain line breaks.
Pattern:
^[^\r\n]*$Maximum length:
2048 - array of stringsspec.applications.whitelistSourceRanges
CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, if not specified.
Example:
whitelistSourceRanges: - 192.168.42.0/24- stringElement of the array
Pattern:
^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$
- booleanspec.highAvailability
Enables high availability mode for
dex-authenticator.When this mode is enabled, multiple pod replicas will be deployed to ensure fault tolerance.
Default:
false - stringspec.keepUsersLoggedInFor
Maximum period of user inactivity during which the user session remains active.
Set as a string of whole hours, minutes, and seconds, in this order:
30m,20s,2h30m10s,24h.Specified value can’t be shorter or equal to the
idTokenTTLvalue set in the module settings. If you set a value that is shorter or equal toidTokenTTL, the effective logout time will beidTokenTTL + 1s.To force logout sooner than the default
idTokenTTL, decrease theidTokenTTLparameter value in the module settings as well.Default:
168hPattern:
^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$ - objectspec.nodeSelector
If specified, the
dex-authenticatorpods nodeSelector.Format: the standard
nodeSelectorlist. Instance pods inherit this field as is. - objectspec.podMetadata
Additional labels and annotations for
dex-authenticatorpods.- objectspec.podMetadata.annotations
Additional annotations for
dex-authenticatorpods. - objectspec.podMetadata.labels
Additional labels for
dex-authenticatorpods.
- objectspec.resources
Container resources (CPU/memory) — requests/limits.
If this field is set, the specified values are applied and VPA is disabled for this instance. If the field is not set, behavior remains the same: when the VPA module is enabled, resources are managed by VPA, when it is disabled, default values are used.
Resources can be specified either directly for the
dex-authenticatorcontainer (for backward compatibility) or in nested objects — separately for each container.- objectspec.resources.limits
Upper limit of resources for the
dex-authenticatorcontainer (CPU/memory). This field is kept for backward compatibility. - objectspec.resources.redis
Resources of the
rediscontainer (CPU/memory) — requests/limits.- objectspec.resources.redis.limits
Upper limit of resources for the
rediscontainer (CPU/memory). - objectspec.resources.redis.requests
Guaranteed minimum resources for the
rediscontainer (CPU/memory).
- objectspec.resources.requests
Guaranteed minimum resources for the
dex-authenticatorcontainer (CPU/memory). This field is kept for backward compatibility.
- boolean
Request to application will be sent with
Authorization: Bearerheader when the option is switched to true.When enabled, the header carries a signed Dex ID token (
id_token) containing the user’s email, name, and group membership. This is the only way to pass the user’s groups to the application via DexAuthenticator: a separateX-Auth-Request-Groupsheader with groups is not sent.Warning. Enable it only if the application can process this header.
When setting
sendAuthorizationHeader: true, list all necessary headers in the application’s Ingress resource (if the application is published through an Ingress) or in the HTTPRoute resource (if the application is published through an ALBInstance or ClusterALBInstance of thealbmodule).Also, if the application is published through an Ingress resource, when setting
sendAuthorizationHeader: true, increase the header buffer size, since a JWT with many groups may not fit into the default buffer.For details on specifying the headers and increasing the buffer, see How to pass the user’s login and groups to an application.
- array of objectsspec.tolerations
If specified the
dex-authenticatorpods tolerations.Format: the standard toleration list. Instance pods inherit this field as is.
- stringspec.tolerations.effect
Defines the taint’s effect this toleration is associated with (it matches any effect if empty).
Allowed values:
NoSchedule,PreferNoSchedule,NoExecute - stringspec.tolerations.key
Defines the taint’s key this toleration is associated with (it matches any key if empty).
If the key is omitted (empty), then
operatormust be set toExists(which means it matches anyvalueandkey). - stringspec.tolerations.operator
Defines how the key and its value are linked — whether the key must be
Equalto the value or can have any value.Setting it to
Existsis equivalent to the value having any value so that the pod with the specified toleration can match the corresponding taint.Default:
EqualAllowed values:
Exists,Equal - integerspec.tolerations.tolerationSeconds
Specifies the period (in seconds) that the scheduler waits before evicting a Pod from a node if the toleration no longer matches the taint (only applicable to the
NoExecuteeffect, otherwise ignored).If the parameter is not set, the Pod will not be evicted from the node if the toleration no longer matches the taint. If the parameter is set to zero (or negative), the Pod will be evicted immediately if the toleration no longer matches the taint.
The default is: not set.
- stringspec.tolerations.value
The value that the toleration must match.
Must be empty if the
operatorparameter is set toExists.
Deprecated resource. Support for the resource might be removed in a later release.
After the DexAuthenticator object appears in the namespace, the following objects will be created:
- Deployment containing OAuth2-Proxy and Redis containers;
- Service, pointing to OAuth2-Proxy;
- Ingress resource, configured to receive requests on
https://<applicationDomain>/dex-authenticatorand send it to a service side; - HTTPRoute resource (optional), configured to receive requests on
https://<applicationDomain>/dex-authenticatorand send it to a service side; - Secrets, needed to access Dex.
Warning. DexAuthenticator only works with HTTPS. The application Ingress must have TLS configured.
Warning. After restarting a pod with an OAuth2-Proxy, the current Access Token and ID Token will be queried (using the refresh token) and stored in a Redis memory.
The name of a DexAuthenticator must be a DNS-1035 label of at most 63 characters: it starts with a lowercase letter and contains only lowercase letters, digits and hyphens. The name is a part of the name of its Service and a label value of the objects it creates.
Examples:
apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
name: app-name
namespace: app-namespace
spec:
applicationDomain: app-name.kube.my-domain.com
sendAuthorizationHeader: false
applicationIngressCertificateSecretName: ingress-tls
applicationIngressClassName: nginx
keepUsersLoggedInFor: 720h
allowedGroups:
- everyone
- admins
allowedProviders:
- local
- corp-ldap
whitelistSourceRanges:
- 1.1.1.1/32
- 192.168.0.0/24
additionalApplications:
- domain: additional-app-name.kube.my-domain.com
ingressSecretName: ingress-tls
ingressClassName: nginx
signOutURL: "/logout"
whitelistSourceRanges:
- 2.2.2.2/32
apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
name: app-alb
namespace: app-namespace
spec:
applicationDomain: app.example.com
gatewayAPI:
applicationHTTPRouteListenerSetName: app-listeners
- objectmetadata
- stringmetadata.name
Maximum length:
63
- objectspec
Required value
- array of objectsspec.additionalApplications
A list of additional applications for which user authentication is required.
- stringspec.additionalApplications.domain
Required value
An application domain from which the user request will be redirected for authentication in Dex.
Warning. Specify a DNS name that complies with RFC 1123 (subdomain) and does not include an HTTP scheme. IP addresses are not allowed.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - objectspec.additionalApplications.gatewayAPI
A set of parameters to use in HTTPRoute object.
Warning. Only applicable in clusters with Gateway API support.
Warning. Define the same ListenerSet object which is used to publish the application domain.
- stringspec.additionalApplications.gatewayAPI.httpRouteListenerSetName
Required value
Name of the ListenerSet object from the Gateway API to be referred to from the HTTPRoute.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
httpRouteListenerSetName: default-listener-set - stringspec.additionalApplications.gatewayAPI.httpRouteListenerSetNamespace
Namespace where the ListenerSet object from the Gateway API is deployed to be referred to from the HTTPRoute.
If not set, the namespace of the
DexAuthenticatoris used.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
63Example:
httpRouteListenerSetNamespace: default - stringspec.additionalApplications.gatewayAPI.httpRouteListenerSetSectionName
Section name from the ListenerSet object in the Gateway API the HTTPRoute refers to.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
httpRouteListenerSetSectionName: web-listener
- stringspec.additionalApplications.ingressClassName
The name of the Ingress class to be used in the Ingress resource (it must match the Ingress class name for the application domain).
Required unless
gatewayAPIis specified. If omitted, no Ingress resources are created for this application. Both fields may be specified.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - stringspec.additionalApplications.ingressSecretName
The name of the Secret containing the TLS certificate (from the domain) used in the applications Ingress resource. The Secret must be in the same namespace as DexAuthenticator.
Pattern:
^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$ - stringspec.additionalApplications.signOutURL
The URL of the application from which requests will be redirected to the sign-out URL of the
dex-authenticator.It is used in the application to direct logout requests. A separate Ingress resource will be created for the specified URL, and requests to it will be redirected to
dex-authenticator.The value must not contain line breaks.
Pattern:
^[^\r\n]*$Maximum length:
2048 - array of stringsspec.additionalApplications.whitelistSourceRanges
CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.
Example:
whitelistSourceRanges: - 192.168.42.0/24- stringElement of the array
Pattern:
^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$
- array of stringsspec.allowedEmails
A list of emails of users are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose email is no longer listed.
By default, all users can connect.
Values must not contain line breaks.
Default:
All emails are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
320
- array of stringsspec.allowedGroups
A list of groups whose members are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose stored groups no longer intersect it.
By default, all groups can connect.
Values must not contain line breaks.
Default:
All groups are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
512
- array of stringsspec.allowedProviders
Names of the DexProvider objects through which users can sign in to the application.
Use
localfor the users of the built-in password database (User).Checked on the sign-in page, on login, and on every refresh-token and token-exchange request. A provider outside the list is not offered on the sign-in page. If the list holds one provider, users go straight to it. Removing a provider from the list stops the refresh tokens that were issued through it.
A name that matches no DexProvider is accepted with a warning. Nobody can sign in through it until the provider appears.
By default, all providers can be used.
Default:
All providers are allowed.- stringElement of the array
Pattern:
^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$Maximum length:
253
- stringspec.applicationDomain
Required value
An address for the application (DNS domain for Ingress resource) from which the user request will be redirected for authentication in Dex.
Warning. Specify a DNS name that complies with RFC 1123 (subdomain) and does not include an HTTP scheme. IP addresses are not allowed.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Example:
applicationDomain: my-app.domain.com - stringspec.applicationIngressCertificateSecretName
The name of the Secret containing the TLS certificate for the application domain (is used in the Ingress resource). The Secret must be located in the same namespace as the DexAuthenticator.
Pattern:
^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$Example:
applicationIngressCertificateSecretName: ingress-tls - stringspec.applicationIngressClassName
The name of the Ingress class to be used in the Ingress resource (it must match the Ingress class name for the application domain).
Required unless
gatewayAPIis specified. If omitted, no Ingress resources are created for this application. Both fields may be specified.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Example:
applicationIngressClassName: nginx - objectspec.gatewayAPI
A set of parameters to use in HTTPRoute object.
Warning. Only applicable in clusters with Gateway API support.
Warning. Define the same ListenerSet object which is used to publish the application domain.
- stringspec.gatewayAPI.applicationHTTPRouteListenerSetName
Required value
Name of the ListenerSet object from the Gateway API to be referred to from the HTTPRoute.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
applicationHTTPRouteListenerSetName: default-listenerset - stringspec.gatewayAPI.applicationHTTPRouteListenerSetNamespace
Namespace where the ListenerSet object from the Gateway API is deployed to be referred to from the HTTPRoute.
If not set, the namespace of the
DexAuthenticatoris used.Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
63Example:
applicationHTTPRouteListenerSetNamespace: default - stringspec.gatewayAPI.applicationHTTPRouteListenerSetSectionName
Section name from the ListenerSet object in the Gateway API the HTTPRoute refers to.
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Maximum length:
253Example:
applicationHTTPRouteListenerSetSectionName: default-listener
- booleanspec.highAvailability
Enables high availability mode for
dex-authenticator.When this mode is enabled, multiple pod replicas will be deployed to ensure fault tolerance.
Default:
false - stringspec.keepUsersLoggedInFor
Maximum period of user inactivity during which the user session remains active.
Set as a string of whole hours, minutes, and seconds, in this order:
30m,20s,2h30m10s,24h.Specified value can’t be shorter or equal to the
idTokenTTLvalue set in the module settings. If you set a value that is shorter or equal toidTokenTTL, the effective logout time will beidTokenTTL + 1s.To force logout sooner than the default
idTokenTTL, decrease theidTokenTTLparameter value in the module settings as well.Default:
168hPattern:
^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$Example:
keepUsersLoggedInFor: 24h - objectspec.nodeSelector
If specified, the
dex-authenticatorpods nodeSelector.Format: the standard
nodeSelectorlist. Instance pods inherit this field as is. - objectspec.podMetadata
Additional labels and annotations for
dex-authenticatorpods.- objectspec.podMetadata.annotations
Additional annotations for
dex-authenticatorpods. - objectspec.podMetadata.labels
Additional labels for
dex-authenticatorpods.
- objectspec.resources
Container resources (CPU/memory) — requests/limits.
If this field is set, the specified values are applied and VPA is disabled for this instance. If the field is not set, behavior remains the same: when the VPA module is enabled, resources are managed by VPA, when it is disabled, default values are used.
Resources can be specified either directly for the
dex-authenticatorcontainer (for backward compatibility) or in nested objects — separately for each container.- objectspec.resources.limits
Upper limit of resources for the
dex-authenticatorcontainer (CPU/memory). This field is kept for backward compatibility. - objectspec.resources.redis
Resources of the
rediscontainer (CPU/memory) — requests/limits.- objectspec.resources.redis.limits
Upper limit of resources for the
rediscontainer (CPU/memory) - objectspec.resources.redis.requests
Guaranteed minimum resources for the
rediscontainer (CPU/memory).
- objectspec.resources.requests
Guaranteed minimum resources for the
dex-authenticatorcontainer (CPU/memory). This field is kept for backward compatibility.
- boolean
Request to application will be sent with
Authorization: Bearerheader when the option is switched to true.When enabled, the header carries a signed Dex ID token (
id_token) containing the user’s email, name, and group membership. This is the only way to pass the user’s groups to the application via DexAuthenticator: a separateX-Auth-Request-Groupsheader with groups is not sent.Warning. Enable it only if the application can process this header.
When setting
sendAuthorizationHeader: true, list all necessary headers in the application’s Ingress resource (if the application is published through an Ingress) or in the HTTPRoute resource (if the application is published through an ALBInstance or ClusterALBInstance of thealbmodule).Also, if the application is published through an Ingress resource, when setting
sendAuthorizationHeader: true, increase the header buffer size, since a JWT with many groups may not fit into the default buffer.For details on specifying the headers and increasing the buffer, see How to pass the user’s login and groups to an application.
- stringspec.signOutURL
The URL of the application from which requests will be redirected to the sign-out URL of the
dex-authenticator.It is used in the application to direct logout requests. A separate Ingress resource will be created for the specified URL, and requests to it will be redirected to
dex-authenticator.The value must not contain line breaks.
Pattern:
^[^\r\n]*$Maximum length:
2048 - array of objectsspec.tolerations
If specified the
dex-authenticatorpods tolerations.Format: the standard toleration list. Instance pods inherit this field as is.
- stringspec.tolerations.effect
Defines the taint’s effect this toleration is associated with (it matches any effect if empty).
Allowed values:
NoSchedule,PreferNoSchedule,NoExecute - stringspec.tolerations.key
Defines the taint’s key this toleration is associated with (it matches any key if empty).
If the key is omitted (empty), then
operatormust be set toExists(which means it matches anyvalueandkey). - stringspec.tolerations.operator
Defines how the key and its value are linked — whether the key must be
Equalto the value or can have any value.Setting it to
Existsis equivalent to the value having any value so that the pod with the specified toleration can match the corresponding taint.Default:
EqualAllowed values:
Exists,Equal - integerspec.tolerations.tolerationSeconds
Specifies the period (in seconds) that the scheduler waits before evicting a Pod from a node if the toleration no longer matches the taint (only applicable to the
NoExecuteeffect, otherwise ignored).If the parameter is not set, the Pod will not be evicted from the node if the toleration no longer matches the taint. If the parameter is set to zero (or negative), the Pod will be evicted immediately if the toleration no longer matches the taint.
The default is: not set.
- stringspec.tolerations.value
The value that the toleration must match.
Must be empty if the
operatorparameter is set toExists.
- array of stringsspec.whitelistSourceRanges
CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.
Example:
whitelistSourceRanges: - 192.168.42.0/24- stringElement of the array
Pattern:
^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$
DexClient
Scope: Namespaced
- v1
- v1alpha1
Allows applications that support OIDC authentication to interact with Dex.
After the DexClient object appears in the cluster:
- Dex will register a client with a
dex-client-<NAME>@<NAMESPACE>clientID, where<NAME>and<NAMESPACE>aremetadata.nameandmetadata.namespaceof the DexClient object, respectively. - A
dex-client-<NAME>Secret containing the client access password (clientSecret) will be created in the corresponding namespace (where<NAME>ismetadata.nameof the DexClient object).
- objectspec
Required value
- array of stringsspec.allowedEmails
A list of emails of users are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose email is no longer listed.
By default, all users can connect.
Values must not contain line breaks.
Default:
All users are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
320
- array of stringsspec.allowedGroups
A list of groups whose members are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose stored groups no longer intersect it.
By default, all groups can connect.
Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
512
- array of stringsspec.allowedProviders
Names of the DexProvider objects through which users can sign in to the application.
Use
localfor the users of the built-in password database (User).Checked on the sign-in page, on login, and on every refresh-token and token-exchange request. A provider outside the list is not offered on the sign-in page. If the list holds one provider, users go straight to it. Removing a provider from the list stops the refresh tokens that were issued through it.
The DexClient can also exchange tokens through every TokenExchangeProvider that lists it in
spec.clients, even when that provider is not in this list.A name that matches no DexProvider is accepted with a warning. Nobody can sign in through it until the provider appears.
By default, all providers can be used.
Default:
All providers are allowed.- stringElement of the array
Pattern:
^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$Maximum length:
253
- stringspec.backchannelLogoutURI
Address Dex notifies when a browser session through which the user signed in to the application ends (OpenID Connect Back-Channel Logout): the user signs out of the session; the provider of the user answers that the user no longer exists or is no longer allowed in; a UserOperation or the self-service of the web interface ends the session; the user is deleted. Dex sends the notification of a session ended outside Dex within seconds.
Works only with the browser sessions of Dex enabled. Dex sends the notification once, without retries: the application cannot rely on it to end its own session.
Must be an HTTPS address whose host is a name with a dot: Dex sends the notification from inside the cluster, so an IP address,
localhost, a name without a dot or ending with one, and a name under.svcor.cluster.localare not accepted. A short name such as<SERVICE>.<NAMESPACE>cannot be told from an external name: use the full external name of the application.Pattern:
^https://[^\r\n]*$Maximum length:
2048 - array of stringsspec.postLogoutRedirectURIs
Addresses Dex may send the browser back to after the user signs out of Dex through the application (
post_logout_redirect_uriof OpenID Connect RP-Initiated Logout).Works only with the browser sessions of Dex enabled.
Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
2048
- array of stringsspec.redirectURIs
Array of URLs that Dex can redirect to after successful authentication.
Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
2048
- stringspec.refreshTokenLifetime
How long the refresh tokens of the application live, with the browser sessions of Dex enabled.
Standalone: The tokens live until they expire, whatever happens to the session of the browser. An application that requests offline access then gets a refresh token only after an interactive sign-in.Session: The tokens end when the user signs out of the session of Dex they were issued through. Such an application can sign the user in from the session of the browser.
Without the parameter, the tokens are
Standalone.Allowed values:
Standalone,Session - objectspec.secretMetadata
Labels and annotations to add to the
dex-client-<NAME>Secret.- objectspec.secretMetadata.annotations
Annotations of the Secret.
- objectspec.secretMetadata.labels
Labels of the Secret.
- array of stringsspec.trustedPeers
OAuth2 client IDs that allowed cross authentication with the current client.
A peer can ask for a token whose audience is this client through a provider the peer’s own
allowedProvidersallows. This client’sallowedProvidersis not checked for that token, and neither areallowedEmailsandallowedGroups.Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
256
Deprecated resource. Support for the resource might be removed in a later release.
Allows applications that support OIDC authentication to interact with Dex.
After the DexClient object appears in the cluster:
- Dex will register a client with a
dex-client-<NAME>@<NAMESPACE>clientID, where<NAME>and<NAMESPACE>aremetadata.nameandmetadata.namespaceof the DexClient object, respectively. - A
dex-client-<NAME>Secret containing the client access password (clientSecret) will be created in the corresponding namespace (where<NAME>ismetadata.nameof the DexClient object).
- objectspec
Required value
- array of stringsspec.allowedEmails
A list of emails of users are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose email is no longer listed.
By default, all users can connect.
Values must not contain line breaks.
Default:
All users are allowed.- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
320
- array of stringsspec.allowedGroups
A list of groups whose members are allowed to connect to the client.
Checked on login and on every refresh-token request. Updating the list denies further refresh for sessions whose stored groups no longer intersect it.
By default, all groups can connect.
Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
512
- array of stringsspec.allowedProviders
Names of the DexProvider objects through which users can sign in to the application.
Use
localfor the users of the built-in password database (User).Checked on the sign-in page, on login, and on every refresh-token and token-exchange request. A provider outside the list is not offered on the sign-in page. If the list holds one provider, users go straight to it. Removing a provider from the list stops the refresh tokens that were issued through it.
The DexClient can also exchange tokens through every TokenExchangeProvider that lists it in
spec.clients, even when that provider is not in this list.A name that matches no DexProvider is accepted with a warning. Nobody can sign in through it until the provider appears.
By default, all providers can be used.
Default:
All providers are allowed.- stringElement of the array
Pattern:
^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$Maximum length:
253
- stringspec.backchannelLogoutURI
Address Dex notifies when a browser session through which the user signed in to the application ends (OpenID Connect Back-Channel Logout): the user signs out of the session; the provider of the user answers that the user no longer exists or is no longer allowed in; a UserOperation or the self-service of the web interface ends the session; the user is deleted. Dex sends the notification of a session ended outside Dex within seconds.
Works only with the browser sessions of Dex enabled. Dex sends the notification once, without retries: the application cannot rely on it to end its own session.
Must be an HTTPS address whose host is a name with a dot: Dex sends the notification from inside the cluster, so an IP address,
localhost, a name without a dot or ending with one, and a name under.svcor.cluster.localare not accepted. A short name such as<SERVICE>.<NAMESPACE>cannot be told from an external name: use the full external name of the application.Pattern:
^https://[^\r\n]*$Maximum length:
2048 - array of stringsspec.postLogoutRedirectURIs
Addresses Dex may send the browser back to after the user signs out of Dex through the application (
post_logout_redirect_uriof OpenID Connect RP-Initiated Logout).Works only with the browser sessions of Dex enabled.
Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
2048
- array of stringsspec.redirectURIs
Array of URLs that Dex can redirect to after successful authentication.
Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
2048
- stringspec.refreshTokenLifetime
How long the refresh tokens of the application live, with the browser sessions of Dex enabled.
Standalone: The tokens live until they expire, whatever happens to the session of the browser. An application that requests offline access then gets a refresh token only after an interactive sign-in.Session: The tokens end when the user signs out of the session of Dex they were issued through. Such an application can sign the user in from the session of the browser.
Without the parameter, the tokens are
Standalone.Allowed values:
Standalone,Session - objectspec.secretMetadata
Labels and annotations to add to the
dex-client-<NAME>Secret.- objectspec.secretMetadata.annotations
Annotations of the Secret.
- objectspec.secretMetadata.labels
Labels of the Secret.
- array of stringsspec.trustedPeers
OAuth2 client IDs that allowed cross authentication with the current client.
A peer can ask for a token whose audience is this client through a provider the peer’s own
allowedProvidersallows. This client’sallowedProvidersis not checked for that token, and neither areallowedEmailsandallowedGroups.Values must not contain line breaks.
- stringElement of the array
Pattern:
^[^\r\n]*$Maximum length:
256
DexProviderCheck
Scope: Cluster
Version: v1
Describes a one-time connectivity check for a DexProvider.
The check verifies that the provider exists, is enabled, Dex is reachable, and the provider endpoint is reachable. It does not perform a full user authentication flow.
- objectspec
Required value
- stringspec.initiatorType
Indicates who initiated the check. Possible values:
Admin: By an administrator.System: Automatically by the system.
Allowed values:
Admin,System - stringspec.providerName
Required value
Name of the DexProvider resource to check.
Example:
providerName: my-oidc
- objectstatus
- array of objectsstatus.checks
Detailed results for individual check steps.
- stringstatus.checks.message
Optional check step message.
- stringstatus.checks.name
Required value
Check step name.
- stringstatus.checks.status
Required value
Check step status. Possible values:
Succeeded: Step completed successfully.Failed: Step failed.Skipped: Step was not applicable and was skipped.Warning: Step completed, but a setting needs attention (for example, disabled TLS verification or a soon-to-expire certificate). It does not fail the overall check.
Allowed values:
Succeeded,Failed,Skipped,Warning
- stringstatus.completedAt
Time when the check completed.
- stringstatus.message
Optional summary of the result or failure reason.
- integerstatus.observedDexProviderGeneration
DexProvider generation observed by the check.
- stringstatus.phase
Current phase of the check. Possible values:
Pending: The check has been picked up and is awaiting or in progress.Succeeded: Connectivity check completed successfully.Failed: Connectivity check failed.
Allowed values:
Pending,Succeeded,Failed
DexProvider
Scope: Cluster
- v1
- v1alpha1
Defines the configuration for connecting a third-party provider.
With it, you can flexibly configure the integration of the account directory with Kubernetes.
Warning. It is forbidden to use users and groups with the system: prefix. Authentication attempts by such users or members of such groups will be rejected, and a corresponding warning will appear in the kube-apiserver logs.
- objectspec
Required value
- objectspec.allowedIdentities
Limits the identities this provider is allowed to assert, regardless of the provider type.
Dex refuses to sign in a user whose email is outside
emailsandemailDomainswhen either is set, and narrows thegroupsclaim to the intersection withgroupswhen it is set (an empty intersection refuses the sign-in). Each list is optional; an omitted or empty list does not limit that attribute.Dex also checks the limits at every refresh-token request and at Basic Authentication of an LDAP provider. It revokes a refresh token outside the limits, and the user has to sign in again. For a Crowd or OIDC provider, basic-auth-proxy checks the credentials with the provider directly, so the limits do not apply to Basic Authentication.
The limits also decide who may create or change the provider. A provider that can assert an email or a group that already carries roles in the cluster may be written only by a requester who is allowed to assign those roles. Without an email limit the provider can assert any email, including the ones that hold
SuperAdmin, so writing it requiresSuperAdmin. With limits on both attributes only the roles granted to the listed identities count. A Crowd or OIDC provider withenableBasicAuth: truecounts as a provider without an email limit, because Basic Authentication bypasses the limits.- array of stringsspec.allowedIdentities.emailDomains
Email domains this provider may assert, without the
@.Matched exactly against the part of the email after the last
@; subdomains must be listed explicitly.- stringElement of the array
- array of stringsspec.allowedIdentities.emails
Exact email addresses this provider may assert.
Compared case-insensitively.
- stringElement of the array
- array of stringsspec.allowedIdentities.groups
Group names this provider may assert, with the
groupPrefixin front when it is set.Applied on top of the provider-specific group filters (
allowedGroups,groups,teams,orgs[].teams), if any.- stringElement of the array
Length:
1..256
- objectspec.bitbucketCloud
Parameters of the Bitbucket Cloud (intended for the
type: BitbucketCloud).- stringspec.bitbucketCloud.clientID
Required value
Team application ID from BitbucketCloud (Key).
- stringspec.bitbucketCloud.clientSecret
Required value
Team application secret key from BitbucketCloud.
- booleanspec.bitbucketCloud.includeTeamGroups
Optional parameter to include team groups.
If enabled, the groups claim of Dex id_token will look like this:
["my_team", "my_team/administrators", "my_team/members"]Default:
false - array of stringsspec.bitbucketCloud.teams
A list of allowed Bitbucket Cloud teams (filter).
The user token will contain a set intersection of Bitbucket Cloud teams and teams from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain the user teams in the
groupsclaim (similar to other providers).
- objectspec.crowd
Parameters of the Crowd (intended for the
type: Crowd).- stringspec.crowd.baseURL
Required value
Base part of Atlassian Crowd URL.
Example:
baseURL: https://crowd.example.com/crowd - stringspec.crowd.clientID
Required value
Application ID from Atlassian Crowd (Application Name).
- stringspec.crowd.clientSecret
Required value
Application secret key from Atlassian Crowd (Password).
- booleanspec.crowd.enableBasicAuth
Enables Basic Authentication to the Kubernetes API server with the Crowd user’s username and password.
Works only when the
apiserver.publishAPIparameter of thecontrol-plane-managermodule is enabled. Only one DexProvider in the cluster can haveenableBasicAuthenabled.The parameter cannot be turned on while
twoFactor.providerTypesincludesCrowd, because Basic Authentication has no page for the second factor.Basic Authentication bypasses
spec.allowedIdentities. Therefore only aSuperAdmincan create a provider with this parameter enabled or enable the parameter in an existing provider.A successful check is cached together with the user’s groups for 2 minutes, and a failed check for 10 seconds. A user whose access is revoked in the identity provider can use the Kubernetes API until the cached result expires.
- array of stringsspec.crowd.groups
A list of allowed Crowd groups (filter).
The user token will contain a set intersection of Crowd groups and groups from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain all Crowd groups if the parameter is not set.
- stringspec.crowd.usernamePrompt
Prompt for username field.
Default:
Crowd username
- stringspec.displayName
Required value
The provider name to show on the authentication provider selection page. The selection page will not be displayed if there is only one provider configured.
- booleanspec.enabled
Whether the provider is enabled.
A disabled provider is not shown on the sign-in page, and users cannot sign in through it. The DexProvider and its settings are kept.
Default:
true - objectspec.github
Parameters of the GitHub provider (intended for the
type: Githubcase only).- stringspec.github.clientID
Required value
Organization application ID from GitHub.
- stringspec.github.clientSecret
Required value
Organization application secret key from GitHub.
- array of objectsspec.github.orgs
Filter for user organizations. ID token will contain only organizations from this list. If the user is not in any organization from this list, an authorization will fail.
By default, all organizations allowed.
- stringspec.github.orgs.name
Required value
Name of organization.
- array of stringsspec.github.orgs.teams
A list of allowed GitHub teams (filter).
The user token will contain a set intersection of teams from GitHub and teams from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain all GitHub teams if the parameter is not set.
- stringspec.github.teamNameField
As an example, group claims for member of ‘Site Reliability Engineers’ in Acme organization would yield:
- [‘acme:Site Reliability Engineers’] for ‘Name’
- [‘acme:site-reliability-engineers’] for ‘Slug’
- [‘acme:Site Reliability Engineers’, ‘acme:site-reliability-engineers’] for ‘Both’
Default:
NameAllowed values:
Name,Slug,Both - booleanspec.github.useLoginAsID
Flag which will switch from using the internal GitHub id to the users handle (@mention) as the user id. It is possible for a user to change their own user name but it is very rare for them to do so.
Equals to false by default.
- objectspec.gitlab
Parameters of the GitLab provider (intended for the
type: Gitlabcase only).- stringspec.gitlab.baseURL
Base part of GitLab URL.
Example:
baseURL: https://gitlab.example.com - stringspec.gitlab.clientID
Required value
Application ID from GitLab.
- stringspec.gitlab.clientSecret
Required value
Application secret key from GitLab.
- array of stringsspec.gitlab.groups
A list (filter) of allowed GitLab groups (group paths and not names).
The user token will contain a set intersection of GitLab groups and groups from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain all GitLab groups if the parameter is not set;
- stringspec.gitlab.rootCAData
A CA chain to validate the provider in PEM format.
Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - booleanspec.gitlab.useLoginAsID
Flag to switch from using the internal GitLab id to the users handle (@mention) as the user id. It is possible for a user to change their own user name but it is very rare for them to do so.
Equals to false by default.
- stringspec.groupPrefix
Prefix that Dex puts in front of every group the provider asserts, whatever the type of the provider.
With a prefix, the groups of this provider are named
<PREFIX><GROUP>in the tokens and in the rules of the cluster, for examplecorp-ldap:admins. The prefix keeps them apart from the groups of another provider only when every provider that can emit such names has its own prefix.The prefix must end with a colon, as in
corp-ldap:. It must differ from the prefix of every other DexProvider and of every TokenExchangeProvider group, and neither of two prefixes may start with the other. The admission webhooks refuse such a prefix.Every name in
allowedIdentities.groupsmust start with the prefix, otherwise the API refuses the manifest, because Dex adds the prefix before it compares. The group settings of the provider type (for example,oidc.allowedGroups,gitlab.groupsandldap.groupSearch) take the names of the identity provider, without the prefix.The prefix cannot start with
system:, which the Kubernetes API server reserves, or withpeering:, which is reserved for the ServiceAccounts of thed8-peeringnamespace. It cannot be set together withenableBasicAuthof anOIDCorCrowdprovider, because basic-auth-proxy checks the credentials with such a provider directly and passes its groups as they are.Setting or changing the prefix renames the groups of the provider, and the rules written for the old names stop applying to its users. Rewrite the rules before you set the prefix, as described in Prefix for the groups of a provider.
By default, no prefix.
Pattern:
^[A-Za-z0-9][A-Za-z0-9._:/-]*:$Length:
2..64Example:
groupPrefix: 'corp-ldap:' - objectspec.ldap
Parameters of the LDAP.
- stringspec.ldap.bindDN
The DN for an application service account. The connector uses these credentials to search for users and groups. Not required if the LDAP server provides access for anonymous auth.
Example:
bindDN: uid=serviceaccount,cn=users,dc=example,dc=com - stringspec.ldap.bindPW
Password of the service account set in
bindDN.Example:
bindPW: password - booleanspec.ldap.enableBasicAuth
Enables Basic Authentication to the Kubernetes API server with the LDAP user’s username and password.
Works only when the
apiserver.publishAPIparameter of thecontrol-plane-managermodule is enabled. Only one DexProvider in the cluster can haveenableBasicAuthenabled.The parameter cannot be turned on while
twoFactor.providerTypesincludesLDAP, because Basic Authentication has no page for the second factor.A successful check is cached together with the user’s groups for 2 minutes, and a failed check for 10 seconds. A user whose access is revoked in the identity provider can use the Kubernetes API until the cached result expires.
- stringspec.ldap.groupSearch.baseDN
Required value
BaseDN to start the search from.
Example:
baseDN: cn=users,dc=example,dc=com - stringspec.ldap.groupSearch.filter
Optional filter to apply when searching the directory.
Example:
filter: "(objectClass=person)" - stringspec.ldap.groupSearch.nameAttr
Required value
Represents group name.
Example:
nameAttr: name - array of objectsspec.ldap.groupSearch.userMatchers
Required value
Following list contains field pairs that are used to match a user to a group. It adds a requirement to the filter that an attribute in the group must match the user’s attribute value.
- stringspec.ldap.groupSearch.userMatchers.groupAttr
Required value
The name of the attribute that stores the group member names.
Example:
groupAttr: member - stringspec.ldap.groupSearch.userMatchers.recursionGroupAttr
Name of the group attribute that stores the DNs of its members.
When it is set, Dex also looks for the groups that contain the found groups, level by level, and adds them to the groups of the user. Use it for nested groups. The value is usually the same as
groupAttr, for examplemember.Dex makes one more search for every group of every level at each sign-in and each refresh of the tokens, so keep
baseDNandfilterofgroupSearchnarrow.Example:
recursionGroupAttr: member - stringspec.ldap.groupSearch.userMatchers.userAttr
Required value
The name of the attribute that stores the user name.
Example:
userAttr: uid
- stringspec.ldap.host
Required value
Host and optional port of the LDAP server in the form “host:port”. If the port is not supplied, it will be guessed based on “insecureNoSSL”, and “startTLS” flags. 389 for insecure or StartTLS connections, 636 otherwise.
Example:
host: ldap.example.com:636 - booleanspec.ldap.insecureNoSSL
Following field is required if the LDAP host is not using TLS (port 389). This option inherently leaks passwords to anyone on the same network as Dex.
Mutually exclusive with
startTLS,insecureSkipVerify, androotCAData: wheninsecureNoSSLis true, TLS is disabled and those settings have no effect.Default:
false - booleanspec.ldap.insecureSkipVerify
If a custom certificate isn’t provided, this option can be used to turn off TLS certificate checks. As noted, it is insecure and shouldn’t be used outside of explorative phases.
Has no effect when
insecureNoSSLis true.Default:
false - objectspec.ldap.kerberos
Optional Kerberos (SPNEGO) SSO settings for LDAP.
- booleanspec.ldap.kerberos.enabled
Enable Kerberos SPNEGO flow for this LDAP provider.
Default:
false - stringspec.ldap.kerberos.expectedRealm
Optional realm to require (case-insensitive).
- booleanspec.ldap.kerberos.fallbackToPassword
If
true, in the absence of/incorrectAuthorization: Negotiateheader, a login/password form will be displayed instead of a 401 response withWWW-Authenticate: Negotiate.Default:
false - stringspec.ldap.kerberos.keytabSecretName
Name of the Secret in the
d8-user-authnnamespace containing thekrb5.keytabkey to mount for Dex.Required when
enabledistrue. - stringspec.ldap.kerberos.krb5ConfConfigMapName
Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this ConfigMap.
- stringspec.ldap.kerberos.krb5ConfSecretName
Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this Secret.
- stringspec.ldap.kerberos.usernameFromPrincipal
How to map Kerberos principal to LDAP username.
Default:
LocalpartAllowed values:
Localpart,SAMAccountName,UserPrincipalName
- stringspec.ldap.rootCAData
A CA chain to validate the provider in PEM format.
Has no effect when
insecureNoSSLis true.Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - booleanspec.ldap.startTLS
When connecting to the server, connect using the ldap:// protocol then issue a StartTLS command. If unspecified, connections will use the ldaps:// protocol.
Mutually exclusive with
insecureNoSSL.Default:
false - objectspec.ldap.userSearch
Required value
User search maps a username and password entered by a user to a LDAP entry. Details…
- stringspec.ldap.userSearch.baseDN
Required value
BaseDN to start the search from.
Example:
baseDN: cn=users,dc=example,dc=com - stringspec.ldap.userSearch.emailAttr
Required value
LDAP attribute that will be matched to Dex user email entry. When an email address is not available, use another value unique to the user, like uid.
Example:
emailAttr: mail - stringspec.ldap.userSearch.filter
Optional filter to apply when searching the directory.
Example:
filter: "(objectClass=person)" - stringspec.ldap.userSearch.idAttr
Required value
LDAP attribute that will be matched to Dex user id entry.
The binary GUID attributes of Active Directory,
objectGUIDandmS-DS-ConsistencyGuid, are supported: the user ID is then the GUID in its string form, for example7ed41c2b-e283-4b10-9cb8-a6e7d1f39a4c.Example:
idAttr: uid - stringspec.ldap.userSearch.nameAttr
LDAP attribute that will be matched to Dex user name entry. No default value provided.
Example:
nameAttr: name - stringspec.ldap.userSearch.username
Username attribute used for comparing user entries. This will be translated and combined with the other filter as “(
= )". Example:
username: uid - array of stringsspec.ldap.userSearch.usernames
Attributes that the entered username is compared with, instead of
username.The search filter has the form
(|(<ATTR_1>=<USERNAME>)(<ATTR_2>=<USERNAME>)), so a user can sign in, for example, with a login or an email. A sign-in is refused if the username matches more than one entry.The Kerberos principal mapped to a username (after
usernameFromPrincipal) is compared with every attribute in the list the same way. List only attributes whose values are unique in the directory and consistent withusernameFromPrincipal. If a value of another entry equals the principal, SSO stops working for that user. A principal that matches none of the attributes of its own entry is matched to the entry of another user.Set either
usernameorusernames.Example:
usernames: - uid - mail- stringElement of the array
Pattern:
^[^\r\n]*$Length:
1..256
- stringspec.ldap.usernamePrompt
The attribute to display in the provided password prompt. If unset, will display “LDAP Username”.
Default:
LDAP usernameExample:
usernamePrompt: SSO Username
- objectspec.oidc
Parameters of the OIDC (intended for the
type: OIDC).- array of stringsspec.oidc.allowedGroups
A list of groups the user must belong to in order to authenticate successfully.
If none of the specified groups match the user’s groups, authentication will be denied.
If the parameter is omitted, no group-based filtering will be applied.
- booleanspec.oidc.basicAuthUnsupported
Use POST requests to interact with the provider instead of including the token in the Basic Authorization header. Generally, Dex automatically determines the type of request to make, while in some cases enabling this parameter can help.
Default:
false - objectspec.oidc.claimMapping
Some providers return non-standard claims (eg. mail). Claim mappings are hints for Dex how to map claims to standard OIDC claims.
Dex can only map a non-standard claim to a standard one if it’s not included in the id_token returned by OIDC provider.
- stringspec.oidc.claimMapping.preferred_username
The claim to use as the user preferred username.
Default:
preferred_username
- booleanspec.oidc.claimMappingOverride
If enabled, the claim mapping will override the standard OIDC claims.
By default, the claim mapping will be used only if the standard OIDC claims are not present, e.g., if there is no
emailclaim in the id_token, theclaimMapping.emailwill be used.Default:
false - stringspec.oidc.clientID
Required value
OIDC issuer application ID.
- stringspec.oidc.clientSecret
Required value
OIDC issuer application secret key.
- booleanspec.oidc.enableBasicAuth
Enables Basic Authentication to the Kubernetes API server with the OIDC user’s username and password.
Works only when the
apiserver.publishAPIparameter of thecontrol-plane-managermodule is enabled. Only one DexProvider in the cluster can haveenableBasicAuthenabled.Basic Authentication bypasses
spec.allowedIdentities. Therefore only aSuperAdmincan create a provider with this parameter enabled or enable the parameter in an existing provider.A successful check is cached together with the user’s groups for 2 minutes, and a failed check for 10 seconds. A user whose access is revoked in the identity provider can use the Kubernetes API until the cached result expires.
- booleanspec.oidc.getUserInfo
Request additional info about the authenticated user.
See UserInfo endpoint.
Default:
false - booleanspec.oidc.insecureSkipEmailVerified
Allow authentication for clients without verified email address.
Default:
false - booleanspec.oidc.insecureSkipVerify
If a custom certificate isn’t provided, this option can be used to turn off TLS certificate checks. As noted, it is insecure and shouldn’t be used outside of explorative phases.
Default:
false - stringspec.oidc.issuer
Required value
Canonical URL of the provider, also used for configuration discovery. This value MUST match the value returned in the provider config discovery.
Example:
issuer: https://accounts.google.com - stringspec.oidc.promptType
Determines if the Issuer should ask for confirmation and provide hints during the authentication process.
By default, the confirmation will be requested on the first authentication. Possible values may vary depending on the Issuer.
Default:
consent - stringspec.oidc.rootCAData
A CA chain to validate the provider in PEM format.
Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - array of stringsspec.oidc.scopes
List of additional scopes to request in token response.
A scope is a single token and must not contain whitespace: the OAuth2 protocol passes scopes as a space-delimited list.
Default:
["openid","profile","email","groups","offline_access"]- stringElement of the array
Pattern:
^\S+$
- booleanspec.oidc.upstreamLogout
Signs the user out of the provider too when the user signs out of Dex.
Works only with the browser sessions of Dex enabled and only when the provider advertises an
end_session_endpoint.By default, signing out of Dex leaves the session of the provider alone: signing out of one application does not sign the user out of everything else that signs in through the provider. The provider may then sign the user in again without a password. To ask for the password at every sign-in, set
promptType: login.Default:
false
- objectspec.saml
Parameters of a SAML provider (intended for the
type: SAML).- array of stringsspec.saml.allowedGroups
If set, only members of at least one of the listed groups will be allowed to log in.
- stringspec.saml.emailAttr
SAML attribute to map to the email claim.
Default:
email - stringspec.saml.entityIssuer
Issuer value that Dex sends in the SAML AuthnRequest (the entity ID of Dex as a service provider). Dex also expects this value in the audience of the SAML assertion.
If not set, the request carries no Issuer, and Dex expects the callback URL in the audience.
- booleanspec.saml.filterGroups
If
true, the connector will filter the groups claim to only include groups from theallowedGroupslist.Default:
false - stringspec.saml.groupsAttr
SAML attribute to map to the groups claim.
- stringspec.saml.groupsDelim
Delimiter to split the groups attribute value if it is a single string.
- booleanspec.saml.insecureSkipSignatureValidation
Skip signature validation of SAML responses. This is insecure and should only be used for testing.
Default:
false - stringspec.saml.nameIDPolicyFormat
The NameIDPolicy format to request from the IdP.
If not set, Dex requests
persistent.A UserOperation
Lockwithspec.targetapplies to the user ID, which Dex takes from the NameID. UsepersistentoremailAddressfor such a lock to work. Withtransient, the IdP returns a new NameID at every sign-in, and a lock does not apply to the next sign-in of the user.Allowed values:
persistent,emailAddress,unspecified,X509SubjectName,WindowsDomainQualifiedName,transient - stringspec.saml.redirectURI
Callback URI.
Overrides the default callback URL. Should be set to
https://<dex-domain>/callback. - stringspec.saml.rootCAData
A CA chain to validate the provider in PEM format.
Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - stringspec.saml.ssoIssuer
Issuer value expected in the SAML response from the IdP.
If not set, the Issuer of the response is not checked.
- stringspec.saml.ssoURL
Required value
SSO URL used for POST value.
Example:
ssoURL: https://idp.example.com/saml/sso - stringspec.saml.usernameAttr
SAML attribute to map to the username claim.
Default:
name
- objectspec.tokenExchange
Settings of token exchange (RFC 8693) through the provider. Dex exchanges an ID token of the provider’s issuer for its own token. Only
OIDCandGitlabproviders can exchange tokens.The provider’s connector does not check the audience of the exchanged token, so any application of the issuer could get a cluster token. Exchange tokens through a TokenExchangeProvider instead. The field is temporary and will be removed after the next LTS release, together with token exchange through a DexProvider.
- booleanspec.tokenExchange.enabled
Whether the provider exchanges tokens. Absent means
false.Exchange can only be turned off. An administrator cannot set
true, either when creating the provider or when changing it. During the upgrade from a release without this field,user-authnsets it once on every existingOIDCandGitlabprovider. It setstrueon all of them if at least one DexClient has thedexclient.deckhouse.io/allow-access-to-kubernetes: "true"annotation, andfalseon all of them otherwise. A DexAuthenticator with access to Kubernetes does not count. Its oauth2-proxy never exchanges tokens, and exchange with its client secret, taken from the Secret in the namespace of the application, is not kept.
- stringspec.type
Required value
Type of authentication provider.
Allowed values:
Github,Gitlab,BitbucketCloud,Crowd,OIDC,LDAP,SAML
Deprecated resource. Support for the resource might be removed in a later release.
Defines the configuration for connecting a third-party provider.
With it, you can flexibly configure the integration of the account directory with Kubernetes.
- objectspec
Required value
- objectspec.allowedIdentities
Limits the identities this provider is allowed to assert, regardless of the provider type.
Dex refuses to sign in a user whose email is outside
emailsandemailDomainswhen either is set, and narrows thegroupsclaim to the intersection withgroupswhen it is set (an empty intersection refuses the sign-in). Each list is optional; an omitted or empty list does not limit that attribute.Dex also checks the limits at every refresh-token request and at Basic Authentication of an LDAP provider. It revokes a refresh token outside the limits, and the user has to sign in again. For a Crowd or OIDC provider, basic-auth-proxy checks the credentials with the provider directly, so the limits do not apply to Basic Authentication.
The limits also decide who may create or change the provider. A provider that can assert an email or a group that already carries roles in the cluster may be written only by a requester who is allowed to assign those roles. Without an email limit the provider can assert any email, including the ones that hold
SuperAdmin, so writing it requiresSuperAdmin. With limits on both attributes only the roles granted to the listed identities count. A Crowd or OIDC provider withenableBasicAuth: truecounts as a provider without an email limit, because Basic Authentication bypasses the limits.- array of stringsspec.allowedIdentities.emailDomains
Email domains this provider may assert, without the
@.Matched exactly against the part of the email after the last
@; subdomains must be listed explicitly.- stringElement of the array
- array of stringsspec.allowedIdentities.emails
Exact email addresses this provider may assert.
Compared case-insensitively.
- stringElement of the array
- array of stringsspec.allowedIdentities.groups
Group names this provider may assert, with the
groupPrefixin front when it is set.Applied on top of the provider-specific group filters (
allowedGroups,groups,teams,orgs[].teams), if any.- stringElement of the array
Length:
1..256
- objectspec.bitbucketCloud
Parameters of the Bitbucket Cloud (intended for the
type: BitbucketCloud).- stringspec.bitbucketCloud.clientID
Required value
Team application ID from BitbucketCloud (Key).
- stringspec.bitbucketCloud.clientSecret
Required value
Team application secret key from BitbucketCloud.
- booleanspec.bitbucketCloud.includeTeamGroups
Optional parameter to include team groups.
If enabled, the groups claim of Dex id_token will look like this:
["my_team", "my_team/administrators", "my_team/members"]Default:
false - array of stringsspec.bitbucketCloud.teams
A list of allowed Bitbucket Cloud teams (filter).
The user token will contain a set intersection of Bitbucket Cloud teams and teams from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain the user teams in the
groupsclaim (similar to other providers).
- objectspec.crowd
Parameters of the Crowd (intended for the
type: Crowd).- stringspec.crowd.baseURL
Required value
Base part of Atlassian Crowd URL.
Example:
baseURL: https://crowd.example.com/crowd - stringspec.crowd.clientID
Required value
Application ID from Atlassian Crowd (Application Name).
- stringspec.crowd.clientSecret
Required value
Application secret key from Atlassian Crowd (Password).
- booleanspec.crowd.enableBasicAuth
Enables Basic Authentication to the Kubernetes API server with the Crowd user’s username and password.
Works only when the
apiserver.publishAPIparameter of thecontrol-plane-managermodule is enabled. Only one DexProvider in the cluster can haveenableBasicAuthenabled.The parameter cannot be turned on while
twoFactor.providerTypesincludesCrowd, because Basic Authentication has no page for the second factor.Basic Authentication bypasses
spec.allowedIdentities. Therefore only aSuperAdmincan create a provider with this parameter enabled or enable the parameter in an existing provider.A successful check is cached together with the user’s groups for 2 minutes, and a failed check for 10 seconds. A user whose access is revoked in the identity provider can use the Kubernetes API until the cached result expires.
- array of stringsspec.crowd.groups
A list of allowed Crowd groups (filter).
The user token will contain a set intersection of Crowd groups and groups from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain all Crowd groups if the parameter is not set.
- stringspec.crowd.usernamePrompt
Prompt for username field.
Default:
Crowd username
- stringspec.displayName
Required value
The provider name to show on the authentication provider selection page. The selection page will not be displayed if there is only one provider configured.
- booleanspec.enabled
Whether the provider is enabled.
A disabled provider is not shown on the sign-in page, and users cannot sign in through it. The DexProvider and its settings are kept.
Default:
true - objectspec.github
Parameters of the GitHub provider (intended for the
type: Githubcase only).- stringspec.github.clientID
Required value
Organization application ID from GitHub.
- stringspec.github.clientSecret
Required value
Organization application secret key from GitHub.
- array of objectsspec.github.orgs
Filter for user organizations. ID token will contain only organizations from this list. If the user is not in any organization from this list, an authorization will fail.
By default, all organizations allowed.
- stringspec.github.orgs.name
Required value
Name of organization.
- array of stringsspec.github.orgs.teams
A list of allowed GitHub teams (filter).
The user token will contain a set intersection of teams from GitHub and teams from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain all GitHub teams if the parameter is not set.
- stringspec.github.teamNameField
As an example, group claims for member of ‘Site Reliability Engineers’ in Acme organization would yield:
- [‘acme:Site Reliability Engineers’] for ‘name’
- [‘acme:site-reliability-engineers’] for ‘slug’
- [‘acme:Site Reliability Engineers’, ‘acme:site-reliability-engineers’] for ‘both’
Default:
nameAllowed values:
name,slug,both - booleanspec.github.useLoginAsID
Flag which will switch from using the internal GitHub id to the users handle (@mention) as the user id. It is possible for a user to change their own user name but it is very rare for them to do so.
Equals to false by default.
- objectspec.gitlab
Parameters of the GitLab provider (intended for the
type: Gitlabcase only).- stringspec.gitlab.baseURL
Base part of GitLab URL.
Example:
baseURL: https://gitlab.example.com - stringspec.gitlab.clientID
Required value
Application ID from GitLab.
- stringspec.gitlab.clientSecret
Required value
Application secret key from GitLab.
- array of stringsspec.gitlab.groups
A list (filter) of allowed GitLab groups (group paths and not names).
The user token will contain a set intersection of GitLab groups and groups from this list. If the set is empty, the authorization will be considered unsuccessful.
The user token will contain all GitLab groups if the parameter is not set;
- stringspec.gitlab.rootCAData
A CA chain to validate the provider in PEM format.
Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - booleanspec.gitlab.useLoginAsID
Flag to switch from using the internal GitLab id to the users handle (@mention) as the user id. It is possible for a user to change their own user name but it is very rare for them to do so.
Equals to false by default.
- stringspec.groupPrefix
Prefix that Dex puts in front of every group the provider asserts, whatever the type of the provider.
With a prefix, the groups of this provider are named
<PREFIX><GROUP>in the tokens and in the rules of the cluster, for examplecorp-ldap:admins. The prefix keeps them apart from the groups of another provider only when every provider that can emit such names has its own prefix.The prefix must end with a colon, as in
corp-ldap:. It must differ from the prefix of every other DexProvider and of every TokenExchangeProvider group, and neither of two prefixes may start with the other. The admission webhooks refuse such a prefix.Every name in
allowedIdentities.groupsmust start with the prefix, otherwise the API refuses the manifest, because Dex adds the prefix before it compares. The group settings of the provider type (for example,oidc.allowedGroups,gitlab.groupsandldap.groupSearch) take the names of the identity provider, without the prefix.The prefix cannot start with
system:, which the Kubernetes API server reserves, or withpeering:, which is reserved for the ServiceAccounts of thed8-peeringnamespace. It cannot be set together withenableBasicAuthof anOIDCorCrowdprovider, because basic-auth-proxy checks the credentials with such a provider directly and passes its groups as they are.Setting or changing the prefix renames the groups of the provider, and the rules written for the old names stop applying to its users. Rewrite the rules before you set the prefix, as described in Prefix for the groups of a provider.
By default, no prefix.
Pattern:
^[A-Za-z0-9][A-Za-z0-9._:/-]*:$Length:
2..64Example:
groupPrefix: 'corp-ldap:' - objectspec.ldap
Parameters of the LDAP.
- stringspec.ldap.bindDN
The DN for an application service account. The connector uses these credentials to search for users and groups. Not required if the LDAP server provides access for anonymous auth.
Example:
bindDN: uid=serviceaccount,cn=users,dc=example,dc=com - stringspec.ldap.bindPW
Password of the service account set in
bindDN.Example:
bindPW: password - booleanspec.ldap.enableBasicAuth
Enables Basic Authentication to the Kubernetes API server with the LDAP user’s username and password.
Works only when the
apiserver.publishAPIparameter of thecontrol-plane-managermodule is enabled. Only one DexProvider in the cluster can haveenableBasicAuthenabled.The parameter cannot be turned on while
twoFactor.providerTypesincludesLDAP, because Basic Authentication has no page for the second factor.A successful check is cached together with the user’s groups for 2 minutes, and a failed check for 10 seconds. A user whose access is revoked in the identity provider can use the Kubernetes API until the cached result expires.
- stringspec.ldap.groupSearch.baseDN
Required value
BaseDN to start the search from.
Example:
baseDN: cn=users,dc=example,dc=com - stringspec.ldap.groupSearch.filter
Optional filter to apply when searching the directory.
Example:
filter: "(objectClass=person)" - stringspec.ldap.groupSearch.nameAttr
Required value
Represents group name.
Example:
nameAttr: name - array of objectsspec.ldap.groupSearch.userMatchers
Required value
Following list contains field pairs that are used to match a user to a group. It adds a requirement to the filter that an attribute in the group must match the user’s attribute value.
- stringspec.ldap.groupSearch.userMatchers.groupAttr
Required value
The name of the attribute that stores the group member names.
Example:
groupAttr: member - stringspec.ldap.groupSearch.userMatchers.recursionGroupAttr
Name of the group attribute that stores the DNs of its members.
When it is set, Dex also looks for the groups that contain the found groups, level by level, and adds them to the groups of the user. Use it for nested groups. The value is usually the same as
groupAttr, for examplemember.Dex makes one more search for every group of every level at each sign-in and each refresh of the tokens, so keep
baseDNandfilterofgroupSearchnarrow.Example:
recursionGroupAttr: member - stringspec.ldap.groupSearch.userMatchers.userAttr
Required value
The name of the attribute that stores the user name.
Example:
userAttr: uid
- stringspec.ldap.host
Required value
Host and optional port of the LDAP server in the form “host:port”. If the port is not supplied, it will be guessed based on “insecureNoSSL”, and “startTLS” flags. 389 for insecure or StartTLS connections, 636 otherwise.
Example:
host: ldap.example.com:636 - booleanspec.ldap.insecureNoSSL
Following field is required if the LDAP host is not using TLS (port 389). This option inherently leaks passwords to anyone on the same network as Dex.
Mutually exclusive with
startTLS,insecureSkipVerify, androotCAData: wheninsecureNoSSLis true, TLS is disabled and those settings have no effect.Default:
false - booleanspec.ldap.insecureSkipVerify
If a custom certificate isn’t provided, this option can be used to turn off TLS certificate checks. As noted, it is insecure and shouldn’t be used outside of explorative phases.
Has no effect when
insecureNoSSLis true.Default:
false - objectspec.ldap.kerberos
Optional Kerberos (SPNEGO) SSO settings for LDAP.
- booleanspec.ldap.kerberos.enabled
Enable Kerberos SPNEGO flow for this LDAP provider.
Default:
false - stringspec.ldap.kerberos.expectedRealm
Optional realm to require (case-insensitive).
- booleanspec.ldap.kerberos.fallbackToPassword
If
true, in the absence of/incorrectAuthorization: Negotiateheader, a login/password form will be displayed instead of a 401 response withWWW-Authenticate: Negotiate.Default:
false - stringspec.ldap.kerberos.keytabSecretName
Name of the Secret in the
d8-user-authnnamespace containing thekrb5.keytabkey to mount for Dex.Required when
enabledistrue. - stringspec.ldap.kerberos.krb5ConfConfigMapName
Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this ConfigMap.
- stringspec.ldap.kerberos.krb5ConfSecretName
Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this Secret.
- stringspec.ldap.kerberos.usernameFromPrincipal
How to map Kerberos principal to LDAP username.
Default:
LocalpartAllowed values:
Localpart,SAMAccountName,UserPrincipalName
- stringspec.ldap.rootCAData
A CA chain to validate the provider in PEM format.
Has no effect when
insecureNoSSLis true.Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - booleanspec.ldap.startTLS
When connecting to the server, connect using the ldap:// protocol then issue a StartTLS command. If unspecified, connections will use the ldaps:// protocol.
Mutually exclusive with
insecureNoSSL.Default:
false - objectspec.ldap.userSearch
Required value
User search maps a username and password entered by a user to a LDAP entry. Details…
- stringspec.ldap.userSearch.baseDN
Required value
BaseDN to start the search from.
Example:
baseDN: cn=users,dc=example,dc=com - stringspec.ldap.userSearch.emailAttr
Required value
LDAP attribute that will be matched to Dex user email entry. When an email address is not available, use another value unique to the user, like uid.
Example:
emailAttr: mail - stringspec.ldap.userSearch.filter
Optional filter to apply when searching the directory.
Example:
filter: "(objectClass=person)" - stringspec.ldap.userSearch.idAttr
Required value
LDAP attribute that will be matched to Dex user id entry.
The binary GUID attributes of Active Directory,
objectGUIDandmS-DS-ConsistencyGuid, are supported: the user ID is then the GUID in its string form, for example7ed41c2b-e283-4b10-9cb8-a6e7d1f39a4c.Example:
idAttr: uid - stringspec.ldap.userSearch.nameAttr
LDAP attribute that will be matched to Dex user name entry. No default value provided.
Example:
nameAttr: name - stringspec.ldap.userSearch.username
Username attribute used for comparing user entries. This will be translated and combined with the other filter as “(
= )". Example:
username: uid - array of stringsspec.ldap.userSearch.usernames
Attributes that the entered username is compared with, instead of
username.The search filter has the form
(|(<ATTR_1>=<USERNAME>)(<ATTR_2>=<USERNAME>)), so a user can sign in, for example, with a login or an email. A sign-in is refused if the username matches more than one entry.The Kerberos principal mapped to a username (after
usernameFromPrincipal) is compared with every attribute in the list the same way. List only attributes whose values are unique in the directory and consistent withusernameFromPrincipal. If a value of another entry equals the principal, SSO stops working for that user. A principal that matches none of the attributes of its own entry is matched to the entry of another user.Set either
usernameorusernames.Example:
usernames: - uid - mail- stringElement of the array
Pattern:
^[^\r\n]*$Length:
1..256
- stringspec.ldap.usernamePrompt
The attribute to display in the provided password prompt. If unset, will display “LDAP Username”.
Default:
LDAP usernameExample:
usernamePrompt: SSO Username
- objectspec.oidc
Parameters of the OIDC (intended for the
type: OIDC).- array of stringsspec.oidc.allowedGroups
A list of groups the user must belong to in order to authenticate successfully.
If none of the specified groups match the user’s groups, authentication will be denied.
If the parameter is omitted, no group-based filtering will be applied.
- booleanspec.oidc.basicAuthUnsupported
Use POST requests to interact with the provider instead of including the token in the Basic Authorization header. Generally, Dex automatically determines the type of request to make, while in some cases enabling this parameter can help.
Default:
false - objectspec.oidc.claimMapping
Some providers return non-standard claims (eg. mail). Claim mappings are hints for Dex how to map claims to standard OIDC claims.
Dex can only map a non-standard claim to a standard one if it’s not included in the id_token returned by OIDC provider.
- stringspec.oidc.claimMapping.preferred_username
The claim to use as the user preferred username.
Default:
preferred_username
- booleanspec.oidc.claimMappingOverride
If enabled, the claim mapping will override the standard OIDC claims.
By default, the claim mapping will be used only if the standard OIDC claims are not present, e.g., if there is no
emailclaim in the id_token, theclaimMapping.emailwill be used.Default:
false - stringspec.oidc.clientID
Required value
OIDC issuer application ID.
- stringspec.oidc.clientSecret
Required value
OIDC issuer application secret key.
- booleanspec.oidc.enableBasicAuth
Enables Basic Authentication to the Kubernetes API server with the OIDC user’s username and password.
Works only when the
apiserver.publishAPIparameter of thecontrol-plane-managermodule is enabled. Only one DexProvider in the cluster can haveenableBasicAuthenabled.Basic Authentication bypasses
spec.allowedIdentities. Therefore only aSuperAdmincan create a provider with this parameter enabled or enable the parameter in an existing provider.A successful check is cached together with the user’s groups for 2 minutes, and a failed check for 10 seconds. A user whose access is revoked in the identity provider can use the Kubernetes API until the cached result expires.
- booleanspec.oidc.getUserInfo
Request additional info about the authenticated user.
See UserInfo endpoint.
Default:
false - booleanspec.oidc.insecureSkipEmailVerified
Allow authentication for clients without verified email address.
Default:
false - booleanspec.oidc.insecureSkipVerify
If a custom certificate isn’t provided, this option can be used to turn off TLS certificate checks. As noted, it is insecure and shouldn’t be used outside of explorative phases.
Default:
false - stringspec.oidc.issuer
Required value
Canonical URL of the provider, also used for configuration discovery. This value MUST match the value returned in the provider config discovery.
Example:
issuer: https://accounts.google.com - stringspec.oidc.promptType
Determines if the Issuer should ask for confirmation and provide hints during the authentication process.
By default, the confirmation will be requested on the first authentication. Possible values may vary depending on the Issuer.
Default:
consent - stringspec.oidc.rootCAData
A CA chain to validate the provider in PEM format.
Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - array of stringsspec.oidc.scopes
List of additional scopes to request in token response.
A scope is a single token and must not contain whitespace: the OAuth2 protocol passes scopes as a space-delimited list.
Default:
["openid","profile","email","groups","offline_access"]- stringElement of the array
Pattern:
^\S+$
- booleanspec.oidc.upstreamLogout
Signs the user out of the provider too when the user signs out of Dex.
Works only with the browser sessions of Dex enabled and only when the provider advertises an
end_session_endpoint.By default, signing out of Dex leaves the session of the provider alone: signing out of one application does not sign the user out of everything else that signs in through the provider. The provider may then sign the user in again without a password. To ask for the password at every sign-in, set
promptType: login.Default:
false
- objectspec.saml
Parameters of a SAML provider (intended for the
type: SAML).- array of stringsspec.saml.allowedGroups
If set, only members of at least one of the listed groups will be allowed to log in.
- stringspec.saml.emailAttr
SAML attribute to map to the email claim.
Default:
email - stringspec.saml.entityIssuer
Issuer value that Dex sends in the SAML AuthnRequest (the entity ID of Dex as a service provider). Dex also expects this value in the audience of the SAML assertion.
If not set, the request carries no Issuer, and Dex expects the callback URL in the audience.
- booleanspec.saml.filterGroups
If
true, the connector will filter the groups claim to only include groups from theallowedGroupslist.Default:
false - stringspec.saml.groupsAttr
SAML attribute to map to the groups claim.
- stringspec.saml.groupsDelim
Delimiter to split the groups attribute value if it is a single string.
- booleanspec.saml.insecureSkipSignatureValidation
Skip signature validation of SAML responses. This is insecure and should only be used for testing.
Default:
false - stringspec.saml.nameIDPolicyFormat
The NameIDPolicy format to request from the IdP.
If not set, Dex requests
persistent.A UserOperation
Lockwithspec.targetapplies to the user ID, which Dex takes from the NameID. UsepersistentoremailAddressfor such a lock to work. Withtransient, the IdP returns a new NameID at every sign-in, and a lock does not apply to the next sign-in of the user.Allowed values:
persistent,emailAddress,unspecified,X509SubjectName,WindowsDomainQualifiedName,transient - stringspec.saml.redirectURI
Callback URI.
Overrides the default callback URL. Should be set to
https://<dex-domain>/callback. - stringspec.saml.rootCAData
A CA chain to validate the provider in PEM format.
Example:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - stringspec.saml.ssoIssuer
Issuer value expected in the SAML response from the IdP.
If not set, the Issuer of the response is not checked.
- stringspec.saml.ssoURL
Required value
SSO URL used for POST value.
Example:
ssoURL: https://idp.example.com/saml/sso - stringspec.saml.usernameAttr
SAML attribute to map to the username claim.
Default:
name
- objectspec.tokenExchange
Settings of token exchange (RFC 8693) through the provider. Dex exchanges an ID token of the provider’s issuer for its own token. Only
OIDCandGitlabproviders can exchange tokens.The provider’s connector does not check the audience of the exchanged token, so any application of the issuer could get a cluster token. Exchange tokens through a TokenExchangeProvider instead. The field is temporary and will be removed after the next LTS release, together with token exchange through a DexProvider.
- booleanspec.tokenExchange.enabled
Whether the provider exchanges tokens. Absent means
false.Exchange can only be turned off. An administrator cannot set
true, either when creating the provider or when changing it. During the upgrade from a release without this field,user-authnsets it once on every existingOIDCandGitlabprovider. It setstrueon all of them if at least one DexClient has thedexclient.deckhouse.io/allow-access-to-kubernetes: "true"annotation, andfalseon all of them otherwise. A DexAuthenticator with access to Kubernetes does not count. Its oauth2-proxy never exchanges tokens, and exchange with its client secret, taken from the Secret in the namespace of the application, is not kept.
- stringspec.type
Required value
Type of authentication provider.
Allowed values:
Github,Gitlab,BitbucketCloud,Crowd,OIDC,LDAP,SAML
Group
Scope: Cluster
Version: v1alpha1
Contains information about a user group.
- objectspec
Required value
- array of objectsspec.members
Required value
List of group members.
- stringspec.members.kind
Required value
Type of a group member.
Allowed values:
User,Group - stringspec.members.name
Required value
For kind User — User.metadata.name. For kind Group — the nested Group.spec.name (the name that appears in tokens), not metadata.name.
- stringspec.name
Required value
Unique group name that appears in the token
groupsclaim and in RBAC subjects. Notmetadata.name.
TokenExchangeProvider
Scope: Cluster
Version: v1alpha1
Defines a trusted issuer of tokens that Dex exchanges for its own tokens (RFC 8693 token exchange).
The name of the object is at most 50 characters.
A client named in spec.clients sends a token of the issuer to the Dex token endpoint and gets a Dex token for the cluster, which the Kubernetes API server accepts like the token of any other Dex user. Typical issuers are CI systems (GitLab CI id_tokens, GitHub Actions), the Dex of a neighbouring cluster, and the ServiceAccount token issuer of another cluster.
Dex checks the signature, the issuer, the expiry and the audience of the token and the required claims, then names the subject as spec.identity says. The provider serves token exchange only and is never shown on the sign-in page.
Warning. Whoever may create the object chooses the issuer, its keys and the names, and so can get a token for any user or group outside the reserved prefixes. This right is equivalent to the right to impersonate users. Grant it to cluster administrators only.
Deleting the object makes the Kubernetes API refuse every token issued through it within seconds if the enableMultiTenancy parameter of the user-authz module is enabled and the cluster runs Kubernetes 1.34 or later. Otherwise these tokens stay valid until they expire (the idTokenTTL parameter of the module).
- objectspec
Required value
- objectspec.allowedIdentities
Limits the identities this provider may assert, as in DexProvider. Dex refuses a subject whose email is outside
emailsandemailDomainswhen either is set, and keeps only the groups listed ingroupswhen it is set.- array of stringsspec.allowedIdentities.emailDomains
Allowed email domains.
- array of stringsspec.allowedIdentities.emails
Allowed email addresses.
- array of stringsspec.allowedIdentities.groups
Allowed groups. The other groups are removed from the subject.
- array of objectsspec.audiences
Required value
Audiences a token is accepted for. A token is accepted if its
audclaim matches at least one entry.- stringspec.audiences.exact
Value that
audmust equal. - stringspec.audiences.prefix
Prefix that
audmust start with.
- array of objectsspec.claimValidation
Claim values a token must carry.
A string claim must equal
equals. A boolean or a number must equalequalswhen written as a string. A list must containequals.- stringspec.claimValidation.claim
Required value
Name of the claim to check.
- stringspec.claimValidation.equals
Required value
Value the claim must have.
- array of objectsspec.clients
Required value
Dex clients that may exchange tokens through this provider. Other clients are refused before their token is checked.
A listed DexClient can exchange tokens through this provider even when its
allowedProvidersdoes not name the provider.- objectspec.clients.dexClient
Required value
DexClient that may exchange tokens. Its client ID is
dex-client-<DEXCLIENT_NAME>@<DEXCLIENT_NAMESPACE>.- stringspec.clients.dexClient.name
Required value
Name of the DexClient.
- stringspec.clients.dexClient.namespace
Required value
Namespace of the DexClient.
- objectspec.identity
Required value
How the subject of a token is named in the cluster. The Kubernetes API server takes the user name from the email, so the email is the user name unless
emailis set.- objectspec.identity.email
Email of the subject, made of
prefixand the value of the string claimclaim. The prefix is required and ends with a colon.- stringspec.identity.email.claim
Required value
Name of the string claim whose value follows the prefix.
- stringspec.identity.email.prefix
Prefix added to the value of the claim. It is required and ends with a colon, such as
ci:.
- array of objectsspec.identity.groups
Groups of the subject, taken from string or list claims.
With
trimPrefix, values that do not start with it are dropped, and it is removed from the others. Thenprefixis added to every remaining value. It is required and ends with a colon.- stringspec.identity.groups.claim
Required value
Name of the string or list claim that holds the groups.
- stringspec.identity.groups.prefix
Prefix added to every group. It is required and ends with a colon, such as
ci:. - stringspec.identity.groups.trimPrefix
Prefix that group values must start with. It is removed from them, and values without it are dropped.
- objectspec.identity.username
Required value
User name of the subject, made of
prefixand the value of the string claimclaim. The prefix is required and ends with a colon.- stringspec.identity.username.claim
Required value
Name of the string claim whose value follows the prefix.
- stringspec.identity.username.prefix
Prefix added to the value of the claim. It is required and ends with a colon, such as
ci:.
- stringspec.issuer
Required value
Issuer of the tokens. It must equal the
issclaim of a token.An https URL without a query or fragment.
Example:
issuer: https://gitlab.example.com - objectspec.keys
Required value
Source of the keys that sign the tokens, either the discovery document of the issuer or public keys given here.
- objectspec.keys.discovery
Settings for reading the keys from the discovery document of the issuer. Dex reads it at the first exchange and again after a failure.
- stringspec.keys.discovery.caData
PEM bundle of the CA that the certificate of the issuer chains to, in addition to the system roots.
- stringspec.keys.discovery.url
HTTPS address of the discovery document.
If not set,
<ISSUER>/.well-known/openid-configurationis used, where<ISSUER>is the value ofspec.issuer.
- objectspec.keys.jwks
Public keys of the issuer (JWK Set, RFC 7517). Use it when the issuer has no discovery document reachable from the cluster, or when several issuers share one URL, such as the ServiceAccount token issuers of different clusters. Private keys are refused. A token that names a key in its
kidheader is verified with the key of thatkidonly, even when the set has one key.- array of objectsspec.keys.jwks.keys
Required value
Public keys in JWK format.
- stringspec.keys.jwks.keys.kty
Required value
Key type, such as
RSAorEC.
- stringspec.subjectTokenMaxLifetime
Longest time a token may be valid, counted from
iattoexp, or from now toexpfor a token withoutiat.A token valid for longer is refused, so that a leaked long-lived token cannot be exchanged for new Dex tokens until it expires. The value is set in hours, minutes and seconds, such as
24hor1h30m.Default:
24hLength:
2..16
- objectstatus
Status of the provider.
While
metadata.deletionTimestampis set, the provider is being revoked, and a client must stop using the tokens it got through it.- array of objectsstatus.conditions
Conditions of the provider. The
Readycondition shows whether the provider exchanges tokens, and itsreasontells why it does not.- stringstatus.conditions.lastTransitionTime
Time the status last changed.
- stringstatus.conditions.message
Details of the status.
- integerstatus.conditions.observedGeneration
Generation of the object that the condition was set for.
- stringstatus.conditions.reason
Reason for the status, such as
PrefixConflict. - stringstatus.conditions.status
Required value
Status of the condition,
True,FalseorUnknown. - stringstatus.conditions.type
Required value
Type of the condition, such as
Ready.
- stringstatus.connectorID
ID of the Dex connector of the provider. Use it as
connector_idin the exchange request. Tokens issued through it carry it in theuser-authn.deckhouse.io/dex-providerextra of the user. - integerstatus.observedGeneration
Generation of the object that the controller processed last.
UserAccount
Scope: Cluster
Version: v1alpha1
Controller-projected view of Dex Password, OfflineSessions, and UserIdentity objects for the Deckhouse web UI.
The controller keeps one UserAccount for each local user and one for each user who has signed in through any external provider.
Do not create or edit UserAccount objects. The user-authn controller owns them.
The source of truth for login credentials and session state remains Dex.
- objectspec
Empty. UserAccount is controller-owned and has no user-editable specification.
Do not create UserAccount objects. The controller projects it from Dex.
- objectstatus
Observed account state projected from Dex.
This is a Deckhouse web UI view only and does not store credentials or connector secrets.
- stringstatus.connectorID
Dex connector identifier.
localfor local accounts; otherwise the DexProvider name. - stringstatus.email
Account email as reported by Dex.
- stringstatus.expireAt
Account expiration time, in RFC3339 format.
- array of stringsstatus.groups
Groups associated with the account.
- integerstatus.incorrectLoginAttempts
Number of consecutive incorrect login attempts recorded in Dex.
Dex counts them for local accounts, and for accounts of LDAP and Atlassian Crowd providers whose type is listed in the
passwordPolicy.lockout.applyToConnectorsmodule parameter.Allowed values:
0 <= X - stringstatus.kind
Account kind.
Possible values:
Local: Dex Password (static user).External: Federated identity from a connector.
Allowed values:
Local,External - stringstatus.lastLogin
Time of the last sign-in through Dex, in RFC3339 format.
Dex records it after the user passes every sign-in step, including 2FA. Basic Authentication to the API server through an LDAP provider with
enableBasicAuthupdates it too, because it goes through Dex.For an account that has not signed in since the upgrade to Deckhouse 1.78, this is the time of its last sign-in that issued a refresh token.
- booleanstatus.locked
Whether the account is currently locked.
- booleanstatus.lockedByAdministrator
Whether the current lock was set by an administrator (as opposed to an automatic password-policy lockout).
This does not make the lock permanent.
lockedUntilstill defines when it expires. - stringstatus.lockedUntil
Time until which the account remains locked, in RFC3339 format.
After this time the lock is lifted automatically, including an administrator lock set for a limited duration (for example, one hour via UserOperation). A permanent administrator lock is stored as a far-future timestamp.
- stringstatus.providerType
External identity provider type.
Equals
spec.typeof the DexProvider, for exampleLDAP,Crowd,OIDC,SAML, orGithub.Empty for local accounts.
- array of objectsstatus.sessions
Devices signed in to the account, the most recently active first.
A device is one of the following:
- a browser signed in to Dex while the
sessionsof Dex are enabled, together with the applications whose refresh tokens are bound to its session (the DexAuthenticator objects, and DexClient objects withrefreshTokenLifetime: Session); - a refresh token not bound to a live session of Dex in a browser: kubeconfig, a device flow, an application of a DexClient, Basic Authentication to the API server, a token whose session has ended while the application keeps it, and, while the sessions of Dex are disabled, every sign-in to an application of a DexAuthenticator.
The list holds at most 50 devices. To sign a device out, create a UserOperation of the
Logouttype with itsidinlogout.session(a browser) orlogout.grant(a refresh token).- array of stringsstatus.sessions.clients
Dex clients (applications) signed in on the device.
- stringstatus.sessions.endsAt
Time when the session of the device ends unless the device is used again, in RFC3339 format. The session ends at the earlier of two limits: the lifetime counted from the sign-in and the time without use counted from the last use.
- For a
Browserdevice, this is the end of its Dex session (thesessions.absoluteLifetimeandsessions.validIfNotUsedForparameters). After it, the browser asks for the password at the next sign-in; the applications it has signed in to stay signed in. - For a
Grantdevice, this is the end of its refresh token (therefreshTokenAbsoluteLifetimeandrefreshTokenValidIfNotUsedForparameters). After it, the device signs in again.
While the device is in use, the time moves forward and is updated with a delay of up to 15 minutes, so the session never ends before the time shown. Not set if the session has no end.
- For a
- stringstatus.sessions.id
Required value
Identifier of the device: the identifier of the session of Dex (the
sidclaim of its tokens) for a browser, the identifier of the refresh token for other devices. - stringstatus.sessions.ipAddress
Client address of the last sign-in of the device, as the Ingress controller passed it to Dex. It locates the device only approximately: a proxy, NAT, or VPN changes it. Behind a balancer that hides the address of the client, it is the address of the balancer (for details, see the Which client address does Dex see? section).
Maximum length:
64 - stringstatus.sessions.kind
Required value
Kind of the device.
Possible values:
Browser: a browser signed in to Dex.Grant: a refresh token not bound to a live session of Dex in a browser.
Allowed values:
Browser,Grant - stringstatus.sessions.knownSince
Time Dex first saw the browser of the device complete a sign-in to the account, in RFC3339 format.
Set when more than a minute earlier than
signedInAt: the browser signed in before, signed out, and signed in again. Dex recognizes the browser by a long-lived cookie it sets at sign-in. Signing out of the other devices on the account, signing out everywhere, and the operations that end every session of the user make Dex forget the browsers, and so does ending this device from another device or by an administrator. - stringstatus.sessions.lastActivity
Time of the last use of the device, in RFC3339 format, rounded down to the hour. A device that signed in less than an hour ago shows its sign-in time.
- stringstatus.sessions.signedInAt
Time the device signed in, in RFC3339 format.
- stringstatus.sessions.userAgent
User-Agent header the device sent at its last sign-in, cut to 512 bytes.
The device sets the header itself. Treat it as text.
Maximum length:
512
- a browser signed in to Dex while the
- booleanstatus.sessionsTruncated
Whether the account has more devices than
sessionslists. The least recently active ones are not listed. - objectstatus.twoFactor
State of the 2FA of the account in Dex, without secrets.
The field shows what the settings ask the users of the type of provider of the account for, whether the account has it, and each method it has.
Set after the first sign-in of the account through Dex. Absent when the second factor does not cover the type of provider of the account.
- booleanstatus.twoFactor.confirmed
Whether the account has what
methodsandrequireask for, with the TOTP secret confirmed by a code.A WebAuthn credential is complete at the registration.
Until the code, a sign-in shows the QR code again.
- booleanstatus.twoFactor.enrolled
Whether the account has what
methodsandrequireask for: a TOTP secret, at least one WebAuthn credential, both (All) or one of them (Any).A secret or a key of a method that is not asked for does not count. Without
methods, whether the account has either. Dex creates the TOTP secret when it shows the user the QR code at a sign-in. - array of stringsstatus.twoFactor.methods
Second factors the settings ask the users of the type of provider of the account for (
twoFactor.methodsof the module, or itsproviderTypeOverridesentry for the type).Absent when 2FA is off or does not cover the type.
- stringElement of the array
Allowed values:
TOTP,WebAuthn
- stringstatus.twoFactor.require
How the two
methodscombine. WithAny, the user passes one of them, withAll, both. Absent with one method.Allowed values:
Any,All - objectstatus.twoFactor.totp
TOTP secret of the account. Absent when there is none.
A UserOperation of the
Reset2FAtype removes it, unlessspec.reset2FA.methodslists onlyWebAuthn.- booleanstatus.twoFactor.totp.confirmed
Whether the user has entered a code for the secret.
- objectstatus.twoFactor.webAuthn
WebAuthn credentials (security keys) of the account. Absent when there is none.
A UserOperation of the
Reset2FAtype removes them, unlessspec.reset2FA.methodslists onlyTOTP.- integerstatus.twoFactor.webAuthn.credentials
Number of registered security keys.
- integerstatus.twoFactor.webAuthn.maxCredentials
How many credentials the account may register (
twoFactor.webAuthn.maxCredentialsof the module).
- stringstatus.userID
Unique user identifier from Dex.
- stringstatus.userRef
Name of the related User resource.
Set for local accounts.
- stringstatus.username
Account username as reported by Dex.
UserOperation
Scope: Cluster
- v1
- v1alpha1
Describes a single-use operation to be applied to a user (password reset, 2FA reset, lock/unlock, logout).
A UserOperation runs once, and changes to its spec after creation are ignored.
The module processes the operation and writes the result to status.phase
(Succeeded or Failed). Operations are automatically deleted after the retention.userOperations setting of the module (24 hours by default).
To perform a new action, create a new UserOperation.
Lock, ResetPassword, Reset2FA, and Logout end the sessions of the user at once. The module
raises the generation of the user’s Dex account (a provider and a user ID), records the revocation
in a Dex Revocation object, and deletes the user’s Dex AuthSession (browser session) and RefreshToken
objects. Dex refuses everything it issued to the account before, and dex-authenticator stops
accepting the user’s sessions within seconds. These operations keep the user’s 2FA secret. Only
Reset2FA removes it, and it also deletes the user’s Dex OfflineSessions object. Unlock and
RequirePasswordChange end no sessions. What an operation revoked is in status.revocation.
- objectspec
Required value
- stringspec.initiatorType
Indicates who initiated the operation. Possible values:
admin: By an administrator (e.g. viad8 iam userCLI or a manual UserOperation).system: Reserved. No component sets this value (Dex locks a user after failed sign-in attempts without creating a UserOperation).self: By the user (sign-out on all devices or password change in the Deckhouse web interface).
- objectspec.lock
Parameters for locking the user.
- stringspec.lock.for
Required value
Lock duration as a Go-style duration string (
30s,10m,1h,2h30m,7d), orpermanentfor an indefinite lock released only byUnlock.1dequals24h.Pattern:
^(permanent|([0-9]+(\.[0-9]+)?(s|m|h|d))+)$
- objectspec.logout
Narrows a
Logoutdown. Without it,Logoutends every session of the user.Set at most one of the fields.
sessionandexceptSessionapply to Dex browser sessions.- stringspec.logout.exceptGrant
ID of the refresh token to keep, for signing out of the other devices from a device without a browser session of Dex. Every browser session of the user ends, except the one the kept refresh token was issued in, and every other refresh token is revoked. A token issued while the operation runs can survive it. The operation fails if the user has no such refresh token.
Pattern:
^[a-z2-7]{1,64}$ - stringspec.logout.exceptSession
ID of the browser session to keep. Every other browser session of the user ends, and every refresh token not issued in the kept session is revoked. A token issued while the operation runs can survive it. The operation fails if the user has no such session.
Pattern:
^[a-z2-7]{1,64}$ - stringspec.logout.grant
ID of the refresh token to revoke: a device signed in without a browser session of Dex, such as a kubeconfig. It is the
idof a device of theGrantkind instatus.sessionsof the UserAccount and thed8_gidclaim of the tokens issued with the refresh token. The other devices keep their sessions. If the user has no such refresh token, for example it has expired, has been revoked or belongs to another user, the operation ends nothing and succeeds with thethe user has no such grantmessage.Pattern:
^[a-z2-7]{1,64}$ - stringspec.logout.session
ID of the browser session to end (the
sidclaim of the tokens issued in it), together with the refresh tokens issued in it. If the user has no such session, for example it has expired or belongs to another user, the operation ends nothing and succeeds with thethe user has no such sessionmessage.Pattern:
^[a-z2-7]{1,64}$
- objectspec.reset2FA
Narrows a
Reset2FAdown. Without it,Reset2FAremoves every second factor of the user.- array of stringsspec.reset2FA.methods
Second factors to remove:
TOTP, the secret of the authenticator application, andWebAuthn, the security keys. The other method stays. The user registers a removed method again at the next sign-in that asks for it. The sessions of the user end whichever methods are listed.- stringElement of the array
Allowed values:
TOTP,WebAuthn
- objectspec.resetPassword
Parameters for password reset.
- stringspec.resetPassword.newPasswordHash
Bcrypt hash of the new password, without Base64 encoding.
- booleanspec.resetPassword.requirePasswordChange
Require the user to change the password at the next sign-in.
With
false, the new password stays valid until the user changes it or until the rotation interval of the password policy ends. A password that does not meet the complexity rules still has to change at the next sign-in.Default:
true
- objectspec.target
Identifier of an account of an external authentication provider, by email.
The
Lock,Unlock,Logout, andReset2FAoperations againsttargetapply to the Dex account (UserIdentity object) of the user whose email at the last sign-in wasemail.connectorIDanduserIDnarrow the search down to one provider and one user ID. The operation fails if no account has the email (the user has never signed in) or if more than one account matches; then setconnectorID, anduserIDif the provider has several users with the email. The operation applies only to the account found: a lock does not lock a local user or a user of another provider with the same email. A local user is addressed byspec.useronly.The lock applies to the user ID that the provider returns at sign-in. A SAML provider must return the same ID at every sign-in, with
nameIDPolicyFormatset topersistentoremailAddressor not set. Withtransient, every sign-in gets a new ID, and the lock does not apply to the next sign-in.Only one of the fields can be specified at the same time:
userortarget.- stringspec.target.connectorID
ID of the DexProvider (connector) through which the user logs in.
Examples:
connectorID: my-ldapconnectorID: my-crowd - stringspec.target.email
Required value
Email of the user, as reported by the provider at the user’s last sign-in.
The comparison is case-insensitive.
Example:
email: jane.doe@example.org - stringspec.target.userID
ID of the user that the provider returns at sign-in (
userIDof the Dex UserIdentity object). It tells apart accounts of a provider with the same email.Example:
userID: cn=jane.doe,ou=people,dc=example,dc=org
- stringspec.type
Required value
Type of the user operation. Possible values:
ResetPassword: Password reset. Applies to local users (spec.user) only.Reset2FA: Two-factor authentication reset. Supports both local users (spec.user) and external users (spec.target). Of the external users, only the users of an LDAP or Atlassian Crowd provider can have a second factor. For a user of a provider of another type, the operation only ends the sessions.Lock: User lock. Supports both local users (spec.user) and external users (spec.target).Unlock: User unlock. Supports both local users (spec.user) and external users (spec.target).Logout: Ends the sessions of the user. Withoutlogout, ends every session in every application and revokes the refresh tokens of kubeconfig files. Supports both local users (spec.user) and external users (spec.target).RequirePasswordChange: The user has to set a new password at the next sign-in. Ends no sessions. Applies to local users (spec.user) only.
Allowed values:
ResetPassword,Reset2FA,Lock,Unlock,Logout,RequirePasswordChange - stringspec.user
Name (username) of the target local User resource.
Used for operations on users that are managed by DP via the User CRD (the built-in local connector).
Only one of the fields can be specified at the same time:
userortarget.Example:
user: jane.doe
- objectstatus
- stringstatus.completedAt
Time when the operation was completed, in RFC 3339 format (e.g.
2025-01-15T10:30:00Z). Empty until the operation finishes processing. - stringstatus.message
Optional message about the result or failure of the operation.
- stringstatus.phase
Current phase of the operation. Possible values:
Succeeded: Operation was completed successfully.Failed: Operation failed.
Allowed values:
Succeeded,Failed - objectstatus.revocation
What the operation revoked. Set by
Lock,ResetPassword,Reset2FA, andLogout.- integerstatus.revocation.authSessionsDeleted
Number of Dex AuthSession objects (browser sessions) of the user the operation deleted.
- integerstatus.revocation.generation
New generation of the user’s Dex account. Everything issued to the account at a lower generation is revoked. Not set when the operation did not revoke the whole account.
- stringstatus.revocation.name
Name of the Dex Revocation object the operation wrote, or of the first of them.
- integerstatus.revocation.refreshTokensDeleted
Number of Dex RefreshToken objects of the user the operation deleted.
Deprecated resource. Support for the resource might be removed in a later release.
Describes an operation to be applied to a user (password reset, 2FA reset, lock/unlock).
The Lock, ResetPassword, and Reset2FA operations end the sessions of the user at once,
as in v1. These operations keep the user’s 2FA secret. Only Reset2FA removes it, and it
also deletes the user’s Dex OfflineSessions object.
- objectspec
Required value
- stringspec.initiatorType
Indicates who initiated the operation. Possible values:
admin: By an administrator.system: Reserved. No component sets this value.self: By the user.
- objectspec.lock
Parameters for locking the user.
- stringspec.lock.for
Required value
Lock duration as a Go-style duration string (
30s,10m,1h,2h30m,7d), orpermanentfor an indefinite lock released only byUnlock.1dequals24h.Pattern:
^(permanent|([0-9]+(\.[0-9]+)?(s|m|h|d))+)$
- objectspec.resetPassword
Parameters for password reset.
- stringspec.resetPassword.newPasswordHash
Bcrypt hash of the new password.
- stringspec.type
Required value
Type of the user operation. Possible values:
ResetPassword: Password reset.Reset2FA: Two-factor authentication reset.Lock: User lock.Unlock: User unlock.
Allowed values:
ResetPassword,Reset2FA,Lock,Unlock - stringspec.user
Required value
Name (username) of the target User resource.
Example:
user: jane.doe
- objectstatus
- stringstatus.completedAt
Time when the operation was completed.
- stringstatus.message
Optional message about the result or failure of the operation.
- stringstatus.phase
Current phase of the operation. Possible values:
Succeeded: Operation completed successfully.Failed: Operation failed.
Allowed values:
Succeeded,Failed
User
Scope: Cluster
- v1
- v1alpha1
Contains information about the static user.
- objectspec
Required value
- stringspec.email
Required value
User email. Must be in lowercase and at most 150 bytes long (150 characters of Latin letters, digits and punctuation): Dex names the object that keeps the password of the user after the email, and the name of a Kubernetes object is at most 253 characters.
To grant this user access, use the
emailvalue as theUsersubject name in a RoleBinding or ClusterRoleBinding of the granular role-based model.Important! Email addresses are case-insensitive for uniqueness validation. Dex automatically converts emails to lowercase during authentication. For new users, uppercase letters in email addresses are not allowed. Existing users with uppercase emails can be updated without changing the email field.
Length:
1..150Example:
email: user@domain.com - array of stringsspec.groupsDeprecated
Static user groups.
Since the parameter has been deprecated, use the Group resource to add users to groups.
- stringspec.password
Required value
User password hash in plaintext or Base64 encoded.
Use the following command to encode the password hash in Base64:
echo -n '<PASSWORD>' | htpasswd -BinC 10 "" | cut -d: -f2 | tr -d '\n' | base64 -w0; echo. You can also create the user withd8 iam user create, which computes the hash locally.Caution. If the password does not meet the complexity rules of the password policy, the user has to change it at the first sign-in. To make the user change the password at the first sign-in in any case, set
requirePasswordChangeOnFirstLogin.Caution. This field is immutable after the User is created. Changing the password via
kubectl editdoes not update Dex credentials and will be rejected. To reset the password, use the UserOperation resource (ord8 iam user).Example:
password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H - booleanspec.requirePasswordChangeOnFirstLogin
Require the user to change the password at the first sign-in.
Applies when the module creates the Dex credentials of the user from
password: when the User is created, created again, or restored from a backup.Can be set only when the User is created. Adding, changing, or removing the field later is rejected.
- stringspec.ttl
Static user TTL.
It is specified as a string containing the time unit in hours and minutes: 30m, 1h, 2h30m, 24h.
You can only set the TTL once. The
expireAtdate will not be updated if you change it again.Pattern:
^([0-9]+h([0-9]+m)?|[0-9]+m)$Example:
ttl: 24h - stringspec.userIDDeprecated
Deprecated. Ignored if set. Dex Password.userID is User.metadata.name.
- objectstatus
- stringstatus.expireAt
User account expiration time. Set only when
spec.ttlis set. At this time the User is deleted and removed from all Groups. - array of stringsstatus.groups
Groups the user belongs to, computed from Group membership. Values are Group.spec.name.
- objectstatus.lock
Information about user account lock. If present, the user cannot authenticate until the specified time or until the lock is manually lifted by an administrator.
Actions on the account (lock, unlock, password reset, forced password change, 2FA reset, logout) are performed via the UserOperation resource. A lock, a password reset, a 2FA reset and a logout end the sessions of the user at once. After a password reset or a forced password change, the user is presented with a password change form on the next successful login. Only a 2FA reset removes the user’s 2FA secret.
- stringstatus.lock.message
Human-readable explanation of the lock reason.
- stringstatus.lock.reason
Machine-readable reason for the account lock. Used for programmatic checks and policy enforcement.
Allowed values:
PasswordPolicyLockout,LockedByAdministrator - booleanstatus.lock.state
Indicates whether the user account is currently locked.
true— account is locked.false— account is active.
- stringstatus.lock.until
The time until which the user is locked, in RFC3339 format. After this time, the account lock will be automatically lifted.
Deprecated resource. Support for the resource might be removed in a later release.
Contains information about the static user.
- objectspec
Required value
- stringspec.email
Required value
User email. Must be in lowercase and at most 150 bytes long (150 characters of Latin letters, digits and punctuation): Dex names the object that keeps the password of the user after the email, and the name of a Kubernetes object is at most 253 characters.
To grant this user access, use the
emailvalue as theUsersubject name in a RoleBinding or ClusterRoleBinding of the granular role-based model.Important! Email addresses are case-insensitive for uniqueness validation. Dex automatically converts emails to lowercase during authentication. For new users, uppercase letters in email addresses are not allowed. Existing users with uppercase emails can be updated without changing the email field.
Length:
1..150Example:
email: user@domain.com - array of stringsspec.groupsDeprecated
Static user groups.
Since the parameter has been deprecated, use the Group resource to add users to groups.
- stringspec.password
Required value
User password hash in plaintext or Base64 encoded.
Use the following command to encode the password hash in Base64:
echo -n '<PASSWORD>' | htpasswd -BinC 10 "" | cut -d: -f2 | tr -d '\n' | base64 -w0; echo. You can also create the user withd8 iam user create, which computes the hash locally.Caution. If the password does not meet the complexity rules of the password policy, the user has to change it at the first sign-in. To make the user change the password at the first sign-in in any case, set
requirePasswordChangeOnFirstLogin.Caution. This field is immutable after the User is created. Changing the password via
kubectl editdoes not update Dex credentials and will be rejected. To reset the password, use the UserOperation resource (ord8 iam user).Example:
password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H - booleanspec.requirePasswordChangeOnFirstLogin
Require the user to change the password at the first sign-in.
Applies when the module creates the Dex credentials of the user from
password: when the User is created, created again, or restored from a backup.Can be set only when the User is created. Adding, changing, or removing the field later is rejected.
- stringspec.ttl
Static user TTL.
It is specified as a string containing the time unit in hours and minutes: 30m, 1h, 2h30m, 24h.
You can only set the TTL once. The
expireAtdate will not be updated if you change it again.Pattern:
^([0-9]+h([0-9]+m)?|[0-9]+m)$Example:
ttl: 24h - stringspec.userID
Deprecated. Ignored if set. Dex Password.userID is User.metadata.name.
Example:
userID: '08a8684b-db88-4b73-90a9-3cd1661f5466'
- objectstatus
- stringstatus.expireAt
User account expiration time. Set only when
spec.ttlis set. At this time the User is deleted and removed from all Groups. - array of stringsstatus.groups
Groups the user belongs to, computed from Group membership. Values are Group.spec.name.
- objectstatus.lock
Information about user account lock. If present with
state: true, the user cannot authenticate until the specified time or until the lock is manually lifted by an administrator.Actions on the account (lock, unlock, password reset, forced password change, 2FA reset, logout) are performed via the UserOperation resource. A lock, a password reset, a 2FA reset and a logout end the sessions of the user at once. After a password reset or a forced password change, the user is presented with a password change form on the next successful login. Only a 2FA reset removes the user’s 2FA secret.
- stringstatus.lock.message
Human-readable explanation of the lock reason.
- stringstatus.lock.reason
Machine-readable reason for the account lock. Used for programmatic checks and policy enforcement.
Allowed values:
PasswordPolicyLockout,LockedByAdministrator - booleanstatus.lock.state
Indicates whether the user account is currently locked.
true— account is locked.false— account is active.
- stringstatus.lock.until
The time until which the user is locked, in RFC3339 format. After this time, the account lock will be automatically lifted.