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-authenticator and send it to a service side;
  • HTTPRoute resource (optional), configured to receive requests on https://<applicationDomain>/dex-authenticator and 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
  • metadata
    object
    • metadata.name
      string

      Maximum length: 63

  • spec
    object

    Required value

    • spec.additionalApplications
      array of objects

      A list of additional applications for which user authentication is required.

      • spec.additionalApplications.domain
        string

        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])?)*$

      • spec.additionalApplications.gatewayAPI
        object

        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.

        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetName
          string

          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: 253

          Example:

          httpRouteListenerSetName: default-listener-set
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetNamespace
          string

          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 DexAuthenticator is used.

          Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Maximum length: 63

          Example:

          httpRouteListenerSetNamespace: default
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetSectionName
          string

          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: 253

          Example:

          httpRouteListenerSetSectionName: web-listener
          
      • spec.additionalApplications.ingressClassName
        string

        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 gatewayAPI is 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])?)*$

      • spec.additionalApplications.ingressSecretName
        string

        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])?)*)$

      • spec.additionalApplications.signOutURL
        string

        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

      • spec.additionalApplications.whitelistSourceRanges
        array of strings

        CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.

        Example:

        whitelistSourceRanges:
        - 192.168.42.0/24
        
        • Element of the array
          string

          Pattern: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

    • spec.allowedEmails
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 320

    • spec.allowedGroups
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 512

    • spec.allowedProviders
      array of strings

      Names of the DexProvider objects through which users can sign in to the application.

      Use local for 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.

      • Element of the array
        string

        Pattern: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Maximum length: 253

    • spec.applicationDomain
      string

      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
      
    • spec.applicationIngressCertificateSecretName
      string

      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
      
    • spec.applicationIngressClassName
      string

      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 gatewayAPI is 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
      
    • spec.gatewayAPI
      object

      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.

      • spec.gatewayAPI.applicationHTTPRouteListenerSetName
        string

        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: 253

        Example:

        applicationHTTPRouteListenerSetName: default-listenerset
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetNamespace
        string

        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 DexAuthenticator is used.

        Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Maximum length: 63

        Example:

        applicationHTTPRouteListenerSetNamespace: default
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetSectionName
        string

        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: 253

        Example:

        applicationHTTPRouteListenerSetSectionName: default-listener
        
    • spec.highAvailability
      boolean

      Enables high availability mode for dex-authenticator.

      When this mode is enabled, multiple pod replicas will be deployed to ensure fault tolerance.

      Default: false

    • spec.keepUsersLoggedInFor
      string

      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 idTokenTTL value set in the module settings. If you set a value that is shorter or equal to idTokenTTL, the effective logout time will be idTokenTTL + 1s.

      To force logout sooner than the default idTokenTTL, decrease the idTokenTTL parameter value in the module settings as well.

      Default: 168h

      Pattern: ^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$

      Example:

      keepUsersLoggedInFor: 24h
      
    • spec.nodeSelector
      object

      If specified, the dex-authenticator pods nodeSelector.

      Format: the standard nodeSelector list. Instance pods inherit this field as is.

    • spec.podMetadata
      object

      Additional labels and annotations for dex-authenticator pods.

      • spec.podMetadata.annotations
        object

        Additional annotations for dex-authenticator pods.

      • spec.podMetadata.labels
        object

        Additional labels for dex-authenticator pods.

    • spec.resources
      object

      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-authenticator container (for backward compatibility) or in nested objects — separately for each container.

      • spec.resources.limits
        object

        Upper limit of resources for the dex-authenticator container (CPU/memory). This field is kept for backward compatibility.

      • spec.resources.redis
        object

        Resources of the redis container (CPU/memory) — requests/limits.

        • spec.resources.redis.limits
          object

          Upper limit of resources for the redis container (CPU/memory)

        • spec.resources.redis.requests
          object

          Guaranteed minimum resources for the redis container (CPU/memory).

      • spec.resources.requests
        object

        Guaranteed minimum resources for the dex-authenticator container (CPU/memory). This field is kept for backward compatibility.

    • spec.sendAuthorizationHeader
      boolean

      Request to application will be sent with Authorization: Bearer header 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 separate X-Auth-Request-Groups header 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 the alb module).

      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.

    • spec.signOutURL
      string

      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

    • spec.tolerations
      array of objects

      If specified the dex-authenticator pods tolerations.

      Format: the standard toleration list. Instance pods inherit this field as is.

      • spec.tolerations.effect
        string

        Defines the taint’s effect this toleration is associated with (it matches any effect if empty).

        Allowed values: NoSchedule, PreferNoSchedule, NoExecute

      • spec.tolerations.key
        string

        Defines the taint’s key this toleration is associated with (it matches any key if empty).

        If the key is omitted (empty), then operator must be set to Exists (which means it matches any value and key).

      • spec.tolerations.operator
        string

        Defines how the key and its value are linked — whether the key must be Equal to the value or can have any value.

        Setting it to Exists is equivalent to the value having any value so that the pod with the specified toleration can match the corresponding taint.

        Default: Equal

        Allowed values: Exists, Equal

      • spec.tolerations.tolerationSeconds
        integer

        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 NoExecute effect, 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.

      • spec.tolerations.value
        string

        The value that the toleration must match.

        Must be empty if the operator parameter is set to Exists.

    • spec.whitelistSourceRanges
      array of strings

      CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.

      Example:

      whitelistSourceRanges:
      - 192.168.42.0/24
      
      • Element of the array
        string

        Pattern: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

  • metadata
    object
    • metadata.name
      string

      Maximum length: 63

  • spec
    object

    Required value

    • spec.allowedEmails
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 320

    • spec.allowedGroups
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 512

    • spec.allowedProviders
      array of strings

      Names of the DexProvider objects through which users can sign in to the application.

      Use local for 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.

      • Element of the array
        string

        Pattern: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Maximum length: 253

    • spec.applications
      array of objects

      Required value

      A list of applications for which user authentication is required.

      • spec.applications.domain
        string

        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])?)*$

      • spec.applications.gatewayAPI
        object

        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.

        • spec.applications.gatewayAPI.httpRouteListenerSetName
          string

          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: 253

          Example:

          httpRouteListenerSetName: default-listener-set
          
        • spec.applications.gatewayAPI.httpRouteListenerSetNamespace
          string

          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 DexAuthenticator is used.

          Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Maximum length: 63

          Example:

          httpRouteListenerSetNamespace: default
          
        • spec.applications.gatewayAPI.httpRouteListenerSetSectionName
          string

          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: 253

          Example:

          httpRouteListenerSetSectionName: web-listener
          
      • spec.applications.ingressClassName
        string

        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 gatewayAPI is 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])?)*$

      • spec.applications.ingressSecretName
        string

        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])?)*)$

      • spec.applications.signOutURL
        string

        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

      • spec.applications.whitelistSourceRanges
        array of strings

        CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, if not specified.

        Example:

        whitelistSourceRanges:
        - 192.168.42.0/24
        
        • Element of the array
          string

          Pattern: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

    • spec.highAvailability
      boolean

      Enables high availability mode for dex-authenticator.

      When this mode is enabled, multiple pod replicas will be deployed to ensure fault tolerance.

      Default: false

    • spec.keepUsersLoggedInFor
      string

      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 idTokenTTL value set in the module settings. If you set a value that is shorter or equal to idTokenTTL, the effective logout time will be idTokenTTL + 1s.

      To force logout sooner than the default idTokenTTL, decrease the idTokenTTL parameter value in the module settings as well.

      Default: 168h

      Pattern: ^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$

    • spec.nodeSelector
      object

      If specified, the dex-authenticator pods nodeSelector.

      Format: the standard nodeSelector list. Instance pods inherit this field as is.

    • spec.podMetadata
      object

      Additional labels and annotations for dex-authenticator pods.

      • spec.podMetadata.annotations
        object

        Additional annotations for dex-authenticator pods.

      • spec.podMetadata.labels
        object

        Additional labels for dex-authenticator pods.

    • spec.resources
      object

      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-authenticator container (for backward compatibility) or in nested objects — separately for each container.

      • spec.resources.limits
        object

        Upper limit of resources for the dex-authenticator container (CPU/memory). This field is kept for backward compatibility.

      • spec.resources.redis
        object

        Resources of the redis container (CPU/memory) — requests/limits.

        • spec.resources.redis.limits
          object

          Upper limit of resources for the redis container (CPU/memory).

        • spec.resources.redis.requests
          object

          Guaranteed minimum resources for the redis container (CPU/memory).

      • spec.resources.requests
        object

        Guaranteed minimum resources for the dex-authenticator container (CPU/memory). This field is kept for backward compatibility.

    • spec.sendAuthorizationHeader
      boolean

      Request to application will be sent with Authorization: Bearer header 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 separate X-Auth-Request-Groups header 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 the alb module).

      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.

    • spec.tolerations
      array of objects

      If specified the dex-authenticator pods tolerations.

      Format: the standard toleration list. Instance pods inherit this field as is.

      • spec.tolerations.effect
        string

        Defines the taint’s effect this toleration is associated with (it matches any effect if empty).

        Allowed values: NoSchedule, PreferNoSchedule, NoExecute

      • spec.tolerations.key
        string

        Defines the taint’s key this toleration is associated with (it matches any key if empty).

        If the key is omitted (empty), then operator must be set to Exists (which means it matches any value and key).

      • spec.tolerations.operator
        string

        Defines how the key and its value are linked — whether the key must be Equal to the value or can have any value.

        Setting it to Exists is equivalent to the value having any value so that the pod with the specified toleration can match the corresponding taint.

        Default: Equal

        Allowed values: Exists, Equal

      • spec.tolerations.tolerationSeconds
        integer

        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 NoExecute effect, 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.

      • spec.tolerations.value
        string

        The value that the toleration must match.

        Must be empty if the operator parameter is set to Exists.

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-authenticator and send it to a service side;
  • HTTPRoute resource (optional), configured to receive requests on https://<applicationDomain>/dex-authenticator and 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
  • metadata
    object
    • metadata.name
      string

      Maximum length: 63

  • spec
    object

    Required value

    • spec.additionalApplications
      array of objects

      A list of additional applications for which user authentication is required.

      • spec.additionalApplications.domain
        string

        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])?)*$

      • spec.additionalApplications.gatewayAPI
        object

        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.

        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetName
          string

          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: 253

          Example:

          httpRouteListenerSetName: default-listener-set
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetNamespace
          string

          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 DexAuthenticator is used.

          Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Maximum length: 63

          Example:

          httpRouteListenerSetNamespace: default
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetSectionName
          string

          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: 253

          Example:

          httpRouteListenerSetSectionName: web-listener
          
      • spec.additionalApplications.ingressClassName
        string

        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 gatewayAPI is 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])?)*$

      • spec.additionalApplications.ingressSecretName
        string

        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])?)*)$

      • spec.additionalApplications.signOutURL
        string

        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

      • spec.additionalApplications.whitelistSourceRanges
        array of strings

        CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.

        Example:

        whitelistSourceRanges:
        - 192.168.42.0/24
        
        • Element of the array
          string

          Pattern: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

    • spec.allowedEmails
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 320

    • spec.allowedGroups
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 512

    • spec.allowedProviders
      array of strings

      Names of the DexProvider objects through which users can sign in to the application.

      Use local for 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.

      • Element of the array
        string

        Pattern: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Maximum length: 253

    • spec.applicationDomain
      string

      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
      
    • spec.applicationIngressCertificateSecretName
      string

      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
      
    • spec.applicationIngressClassName
      string

      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 gatewayAPI is 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
      
    • spec.gatewayAPI
      object

      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.

      • spec.gatewayAPI.applicationHTTPRouteListenerSetName
        string

        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: 253

        Example:

        applicationHTTPRouteListenerSetName: default-listenerset
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetNamespace
        string

        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 DexAuthenticator is used.

        Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Maximum length: 63

        Example:

        applicationHTTPRouteListenerSetNamespace: default
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetSectionName
        string

        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: 253

        Example:

        applicationHTTPRouteListenerSetSectionName: default-listener
        
    • spec.highAvailability
      boolean

      Enables high availability mode for dex-authenticator.

      When this mode is enabled, multiple pod replicas will be deployed to ensure fault tolerance.

      Default: false

    • spec.keepUsersLoggedInFor
      string

      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 idTokenTTL value set in the module settings. If you set a value that is shorter or equal to idTokenTTL, the effective logout time will be idTokenTTL + 1s.

      To force logout sooner than the default idTokenTTL, decrease the idTokenTTL parameter value in the module settings as well.

      Default: 168h

      Pattern: ^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$

      Example:

      keepUsersLoggedInFor: 24h
      
    • spec.nodeSelector
      object

      If specified, the dex-authenticator pods nodeSelector.

      Format: the standard nodeSelector list. Instance pods inherit this field as is.

    • spec.podMetadata
      object

      Additional labels and annotations for dex-authenticator pods.

      • spec.podMetadata.annotations
        object

        Additional annotations for dex-authenticator pods.

      • spec.podMetadata.labels
        object

        Additional labels for dex-authenticator pods.

    • spec.resources
      object

      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-authenticator container (for backward compatibility) or in nested objects — separately for each container.

      • spec.resources.limits
        object

        Upper limit of resources for the dex-authenticator container (CPU/memory). This field is kept for backward compatibility.

      • spec.resources.redis
        object

        Resources of the redis container (CPU/memory) — requests/limits.

        • spec.resources.redis.limits
          object

          Upper limit of resources for the redis container (CPU/memory)

        • spec.resources.redis.requests
          object

          Guaranteed minimum resources for the redis container (CPU/memory).

      • spec.resources.requests
        object

        Guaranteed minimum resources for the dex-authenticator container (CPU/memory). This field is kept for backward compatibility.

    • spec.sendAuthorizationHeader
      boolean

      Request to application will be sent with Authorization: Bearer header 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 separate X-Auth-Request-Groups header 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 the alb module).

      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.

    • spec.signOutURL
      string

      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

    • spec.tolerations
      array of objects

      If specified the dex-authenticator pods tolerations.

      Format: the standard toleration list. Instance pods inherit this field as is.

      • spec.tolerations.effect
        string

        Defines the taint’s effect this toleration is associated with (it matches any effect if empty).

        Allowed values: NoSchedule, PreferNoSchedule, NoExecute

      • spec.tolerations.key
        string

        Defines the taint’s key this toleration is associated with (it matches any key if empty).

        If the key is omitted (empty), then operator must be set to Exists (which means it matches any value and key).

      • spec.tolerations.operator
        string

        Defines how the key and its value are linked — whether the key must be Equal to the value or can have any value.

        Setting it to Exists is equivalent to the value having any value so that the pod with the specified toleration can match the corresponding taint.

        Default: Equal

        Allowed values: Exists, Equal

      • spec.tolerations.tolerationSeconds
        integer

        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 NoExecute effect, 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.

      • spec.tolerations.value
        string

        The value that the toleration must match.

        Must be empty if the operator parameter is set to Exists.

    • spec.whitelistSourceRanges
      array of strings

      CIDRs that are allowed to authenticate. Authentication is allowed without IP address restrictions, If not specified.

      Example:

      whitelistSourceRanges:
      - 192.168.42.0/24
      
      • Element of the array
        string

        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> are metadata.name and metadata.namespace of the DexClient object, respectively.
  • A dex-client-<NAME> Secret containing the client access password (clientSecret) will be created in the corresponding namespace (where <NAME> is metadata.name of the DexClient object).

Usage example…

  • spec
    object

    Required value

    • spec.allowedEmails
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 320

    • spec.allowedGroups
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 512

    • spec.allowedProviders
      array of strings

      Names of the DexProvider objects through which users can sign in to the application.

      Use local for 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.

      • Element of the array
        string

        Pattern: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Maximum length: 253

    • spec.backchannelLogoutURI
      string

      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 .svc or .cluster.local are 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

    • spec.postLogoutRedirectURIs
      array of strings

      Addresses Dex may send the browser back to after the user signs out of Dex through the application (post_logout_redirect_uri of OpenID Connect RP-Initiated Logout).

      Works only with the browser sessions of Dex enabled.

      Values must not contain line breaks.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 2048

    • spec.redirectURIs
      array of strings

      Array of URLs that Dex can redirect to after successful authentication.

      Values must not contain line breaks.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 2048

    • spec.refreshTokenLifetime
      string

      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

    • spec.secretMetadata
      object

      Labels and annotations to add to the dex-client-<NAME> Secret.

      • spec.secretMetadata.annotations
        object

        Annotations of the Secret.

      • spec.secretMetadata.labels
        object

        Labels of the Secret.

    • spec.trustedPeers
      array of strings

      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 allowedProviders allows. This client’s allowedProviders is not checked for that token, and neither are allowedEmails and allowedGroups.

      Values must not contain line breaks.

      Details…

      • Element of the array
        string

        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> are metadata.name and metadata.namespace of the DexClient object, respectively.
  • A dex-client-<NAME> Secret containing the client access password (clientSecret) will be created in the corresponding namespace (where <NAME> is metadata.name of the DexClient object).

Usage example…

  • spec
    object

    Required value

    • spec.allowedEmails
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 320

    • spec.allowedGroups
      array of strings

      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.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 512

    • spec.allowedProviders
      array of strings

      Names of the DexProvider objects through which users can sign in to the application.

      Use local for 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.

      • Element of the array
        string

        Pattern: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Maximum length: 253

    • spec.backchannelLogoutURI
      string

      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 .svc or .cluster.local are 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

    • spec.postLogoutRedirectURIs
      array of strings

      Addresses Dex may send the browser back to after the user signs out of Dex through the application (post_logout_redirect_uri of OpenID Connect RP-Initiated Logout).

      Works only with the browser sessions of Dex enabled.

      Values must not contain line breaks.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 2048

    • spec.redirectURIs
      array of strings

      Array of URLs that Dex can redirect to after successful authentication.

      Values must not contain line breaks.

      • Element of the array
        string

        Pattern: ^[^\r\n]*$

        Maximum length: 2048

    • spec.refreshTokenLifetime
      string

      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

    • spec.secretMetadata
      object

      Labels and annotations to add to the dex-client-<NAME> Secret.

      • spec.secretMetadata.annotations
        object

        Annotations of the Secret.

      • spec.secretMetadata.labels
        object

        Labels of the Secret.

    • spec.trustedPeers
      array of strings

      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 allowedProviders allows. This client’s allowedProviders is not checked for that token, and neither are allowedEmails and allowedGroups.

      Values must not contain line breaks.

      Details…

      • Element of the array
        string

        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.

  • spec
    object

    Required value

    • spec.initiatorType
      string

      Indicates who initiated the check. Possible values:

      • Admin: By an administrator.
      • System: Automatically by the system.

      Allowed values: Admin, System

    • spec.providerName
      string

      Required value

      Name of the DexProvider resource to check.

      Example:

      providerName: my-oidc
      
  • status
    object
    • status.checks
      array of objects

      Detailed results for individual check steps.

      • status.checks.message
        string

        Optional check step message.

      • status.checks.name
        string

        Required value

        Check step name.

      • status.checks.status
        string

        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

    • status.completedAt
      string

      Time when the check completed.

    • status.message
      string

      Optional summary of the result or failure reason.

    • status.observedDexProviderGeneration
      integer

      DexProvider generation observed by the check.

    • status.phase
      string

      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.

Usage example…

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.

  • spec
    object

    Required value

    • spec.allowedIdentities
      object

      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 emails and emailDomains when either is set, and narrows the groups claim to the intersection with groups when 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 requires SuperAdmin. With limits on both attributes only the roles granted to the listed identities count. A Crowd or OIDC provider with enableBasicAuth: true counts as a provider without an email limit, because Basic Authentication bypasses the limits.

      • spec.allowedIdentities.emailDomains
        array of strings

        Email domains this provider may assert, without the @.

        Matched exactly against the part of the email after the last @; subdomains must be listed explicitly.

        • Element of the array
          string
      • spec.allowedIdentities.emails
        array of strings

        Exact email addresses this provider may assert.

        Compared case-insensitively.

        • Element of the array
          string
      • spec.allowedIdentities.groups
        array of strings

        Group names this provider may assert, with the groupPrefix in front when it is set.

        Applied on top of the provider-specific group filters (allowedGroups, groups, teams, orgs[].teams), if any.

        • Element of the array
          string

          Length: 1..256

    • spec.bitbucketCloud
      object

      Parameters of the Bitbucket Cloud (intended for the type: BitbucketCloud).

      • spec.bitbucketCloud.clientID
        string

        Required value

        Team application ID from BitbucketCloud (Key).

      • spec.bitbucketCloud.clientSecret
        string

        Required value

        Team application secret key from BitbucketCloud.

      • spec.bitbucketCloud.includeTeamGroups
        boolean

        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

      • spec.bitbucketCloud.teams
        array of strings

        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 groups claim (similar to other providers).

    • spec.crowd
      object

      Parameters of the Crowd (intended for the type: Crowd).

      • spec.crowd.baseURL
        string

        Required value

        Base part of Atlassian Crowd URL.

        Example:

        baseURL: https://crowd.example.com/crowd
        
      • spec.crowd.clientID
        string

        Required value

        Application ID from Atlassian Crowd (Application Name).

      • spec.crowd.clientSecret
        string

        Required value

        Application secret key from Atlassian Crowd (Password).

      • spec.crowd.enableBasicAuth
        boolean

        Enables Basic Authentication to the Kubernetes API server with the Crowd user’s username and password.

        Works only when the apiserver.publishAPI parameter of the control-plane-manager module is enabled. Only one DexProvider in the cluster can have enableBasicAuth enabled.

        The parameter cannot be turned on while twoFactor.providerTypes includes Crowd, because Basic Authentication has no page for the second factor.

        Basic Authentication bypasses spec.allowedIdentities. Therefore only a SuperAdmin can 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.

      • spec.crowd.groups
        array of strings

        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.

      • spec.crowd.usernamePrompt
        string

        Prompt for username field.

        Default: Crowd username

    • spec.displayName
      string

      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.

    • spec.enabled
      boolean

      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

    • spec.github
      object

      Parameters of the GitHub provider (intended for the type: Github case only).

      • spec.github.clientID
        string

        Required value

        Organization application ID from GitHub.

      • spec.github.clientSecret
        string

        Required value

        Organization application secret key from GitHub.

      • spec.github.orgs
        array of objects

        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.

        • spec.github.orgs.name
          string

          Required value

          Name of organization.

        • spec.github.orgs.teams
          array of strings

          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.

      • spec.github.teamNameField
        string

        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: Name

        Allowed values: Name, Slug, Both

      • spec.github.useLoginAsID
        boolean

        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.

    • spec.gitlab
      object

      Parameters of the GitLab provider (intended for the type: Gitlab case only).

      • spec.gitlab.baseURL
        string

        Base part of GitLab URL.

        Example:

        baseURL: https://gitlab.example.com
        
      • spec.gitlab.clientID
        string

        Required value

        Application ID from GitLab.

      • spec.gitlab.clientSecret
        string

        Required value

        Application secret key from GitLab.

      • spec.gitlab.groups
        array of strings

        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;

      • spec.gitlab.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.gitlab.useLoginAsID
        boolean

        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.

    • spec.groupPrefix
      string

      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 example corp-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.groups must 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.groups and ldap.groupSearch) take the names of the identity provider, without the prefix.

      The prefix cannot start with system:, which the Kubernetes API server reserves, or with peering:, which is reserved for the ServiceAccounts of the d8-peering namespace. It cannot be set together with enableBasicAuth of an OIDC or Crowd provider, 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..64

      Example:

      groupPrefix: 'corp-ldap:'
      
    • spec.ldap
      object

      Parameters of the LDAP.

      • spec.ldap.bindDN
        string

        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
        
      • spec.ldap.bindPW
        string

        Password of the service account set in bindDN.

        Example:

        bindPW: password
        
      • spec.ldap.enableBasicAuth
        boolean

        Enables Basic Authentication to the Kubernetes API server with the LDAP user’s username and password.

        Works only when the apiserver.publishAPI parameter of the control-plane-manager module is enabled. Only one DexProvider in the cluster can have enableBasicAuth enabled.

        The parameter cannot be turned on while twoFactor.providerTypes includes LDAP, 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.

      • spec.ldap.groupSearch
        object

        Group search queries for groups given a user entry. Details

        • spec.ldap.groupSearch.baseDN
          string

          Required value

          BaseDN to start the search from.

          Example:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.groupSearch.filter
          string

          Optional filter to apply when searching the directory.

          Example:

          filter: "(objectClass=person)"
          
        • spec.ldap.groupSearch.nameAttr
          string

          Required value

          Represents group name.

          Example:

          nameAttr: name
          
        • spec.ldap.groupSearch.userMatchers
          array of objects

          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.

          • spec.ldap.groupSearch.userMatchers.groupAttr
            string

            Required value

            The name of the attribute that stores the group member names.

            Example:

            groupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.recursionGroupAttr
            string

            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 example member.

            Dex makes one more search for every group of every level at each sign-in and each refresh of the tokens, so keep baseDN and filter of groupSearch narrow.

            Example:

            recursionGroupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.userAttr
            string

            Required value

            The name of the attribute that stores the user name.

            Example:

            userAttr: uid
            
      • spec.ldap.host
        string

        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
        
      • spec.ldap.insecureNoSSL
        boolean

        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, and rootCAData: when insecureNoSSL is true, TLS is disabled and those settings have no effect.

        Default: false

      • spec.ldap.insecureSkipVerify
        boolean

        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 insecureNoSSL is true.

        Default: false

      • spec.ldap.kerberos
        object

        Optional Kerberos (SPNEGO) SSO settings for LDAP.

        • spec.ldap.kerberos.enabled
          boolean

          Enable Kerberos SPNEGO flow for this LDAP provider.

          Default: false

        • spec.ldap.kerberos.expectedRealm
          string

          Optional realm to require (case-insensitive).

        • spec.ldap.kerberos.fallbackToPassword
          boolean

          If true, in the absence of/incorrect Authorization: Negotiate header, a login/password form will be displayed instead of a 401 response with WWW-Authenticate: Negotiate.

          Default: false

        • spec.ldap.kerberos.keytabSecretName
          string

          Name of the Secret in the d8-user-authn namespace containing the krb5.keytab key to mount for Dex.

          Required when enabled is true.

        • spec.ldap.kerberos.krb5ConfConfigMapName
          string

          Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this ConfigMap.

        • spec.ldap.kerberos.krb5ConfSecretName
          string

          Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this Secret.

        • spec.ldap.kerberos.usernameFromPrincipal
          string

          How to map Kerberos principal to LDAP username.

          Default: Localpart

          Allowed values: Localpart, SAMAccountName, UserPrincipalName

      • spec.ldap.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Has no effect when insecureNoSSL is true.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.ldap.startTLS
        boolean

        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

      • spec.ldap.userSearch
        object

        Required value

        User search maps a username and password entered by a user to a LDAP entry. Details…

        • spec.ldap.userSearch.baseDN
          string

          Required value

          BaseDN to start the search from.

          Example:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.userSearch.emailAttr
          string

          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
          
        • spec.ldap.userSearch.filter
          string

          Optional filter to apply when searching the directory.

          Example:

          filter: "(objectClass=person)"
          
        • spec.ldap.userSearch.idAttr
          string

          Required value

          LDAP attribute that will be matched to Dex user id entry.

          The binary GUID attributes of Active Directory, objectGUID and mS-DS-ConsistencyGuid, are supported: the user ID is then the GUID in its string form, for example 7ed41c2b-e283-4b10-9cb8-a6e7d1f39a4c.

          Example:

          idAttr: uid
          
        • spec.ldap.userSearch.nameAttr
          string

          LDAP attribute that will be matched to Dex user name entry. No default value provided.

          Example:

          nameAttr: name
          
        • spec.ldap.userSearch.username
          string

          Username attribute used for comparing user entries. This will be translated and combined with the other filter as “(=)".

          Example:

          username: uid
          
        • spec.ldap.userSearch.usernames
          array of strings

          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 with usernameFromPrincipal. 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 username or usernames.

          Example:

          usernames:
          - uid
          - mail
          
          • Element of the array
            string

            Pattern: ^[^\r\n]*$

            Length: 1..256

      • spec.ldap.usernamePrompt
        string

        The attribute to display in the provided password prompt. If unset, will display “LDAP Username”.

        Default: LDAP username

        Example:

        usernamePrompt: SSO Username
        
    • spec.oidc
      object

      Parameters of the OIDC (intended for the type: OIDC).

      • spec.oidc.allowedGroups
        array of strings

        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.

      • spec.oidc.basicAuthUnsupported
        boolean

        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

      • spec.oidc.claimMapping
        object

        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.

        • spec.oidc.claimMapping.email
          string

          The claim to use as the user email.

          Default: email

        • spec.oidc.claimMapping.groups
          string

          The claim to use as the user groups.

          Default: groups

        • spec.oidc.claimMapping.preferred_username
          string

          The claim to use as the user preferred username.

          Default: preferred_username

      • spec.oidc.claimMappingOverride
        boolean

        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 email claim in the id_token, the claimMapping.email will be used.

        Default: false

      • spec.oidc.clientID
        string

        Required value

        OIDC issuer application ID.

      • spec.oidc.clientSecret
        string

        Required value

        OIDC issuer application secret key.

      • spec.oidc.enableBasicAuth
        boolean

        Enables Basic Authentication to the Kubernetes API server with the OIDC user’s username and password.

        Works only when the apiserver.publishAPI parameter of the control-plane-manager module is enabled. Only one DexProvider in the cluster can have enableBasicAuth enabled.

        Basic Authentication bypasses spec.allowedIdentities. Therefore only a SuperAdmin can 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.

      • spec.oidc.getUserInfo
        boolean

        Request additional info about the authenticated user.

        See UserInfo endpoint.

        Default: false

      • spec.oidc.insecureSkipEmailVerified
        boolean

        Allow authentication for clients without verified email address.

        Default: false

      • spec.oidc.insecureSkipVerify
        boolean

        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

      • spec.oidc.issuer
        string

        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
        
      • spec.oidc.promptType
        string

        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

      • spec.oidc.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.oidc.scopes
        array of strings

        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"]

        • Element of the array
          string

          Pattern: ^\S+$

      • spec.oidc.upstreamLogout
        boolean

        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

      • spec.oidc.userIDKey
        string

        The claim to use as the user id.

        Default: sub

      • spec.oidc.userNameKey
        string

        The claim to use as the user name.

        Default: name

    • spec.saml
      object

      Parameters of a SAML provider (intended for the type: SAML).

      • spec.saml.allowedGroups
        array of strings

        If set, only members of at least one of the listed groups will be allowed to log in.

      • spec.saml.emailAttr
        string

        SAML attribute to map to the email claim.

        Default: email

      • spec.saml.entityIssuer
        string

        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.

      • spec.saml.filterGroups
        boolean

        If true, the connector will filter the groups claim to only include groups from the allowedGroups list.

        Default: false

      • spec.saml.groupsAttr
        string

        SAML attribute to map to the groups claim.

      • spec.saml.groupsDelim
        string

        Delimiter to split the groups attribute value if it is a single string.

      • spec.saml.insecureSkipSignatureValidation
        boolean

        Skip signature validation of SAML responses. This is insecure and should only be used for testing.

        Default: false

      • spec.saml.nameIDPolicyFormat
        string

        The NameIDPolicy format to request from the IdP.

        If not set, Dex requests persistent.

        A UserOperation Lock with spec.target applies to the user ID, which Dex takes from the NameID. Use persistent or emailAddress for such a lock to work. With transient, 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

      • spec.saml.redirectURI
        string

        Callback URI.

        Overrides the default callback URL. Should be set to https://<dex-domain>/callback.

      • spec.saml.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.saml.ssoIssuer
        string

        Issuer value expected in the SAML response from the IdP.

        If not set, the Issuer of the response is not checked.

      • spec.saml.ssoURL
        string

        Required value

        SSO URL used for POST value.

        Example:

        ssoURL: https://idp.example.com/saml/sso
        
      • spec.saml.usernameAttr
        string

        SAML attribute to map to the username claim.

        Default: name

    • spec.tokenExchange
      object

      Settings of token exchange (RFC 8693) through the provider. Dex exchanges an ID token of the provider’s issuer for its own token. Only OIDC and Gitlab providers 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.

      • spec.tokenExchange.enabled
        boolean

        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-authn sets it once on every existing OIDC and Gitlab provider. It sets true on all of them if at least one DexClient has the dexclient.deckhouse.io/allow-access-to-kubernetes: "true" annotation, and false on 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.

    • spec.type
      string

      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.

Usage example…

  • spec
    object

    Required value

    • spec.allowedIdentities
      object

      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 emails and emailDomains when either is set, and narrows the groups claim to the intersection with groups when 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 requires SuperAdmin. With limits on both attributes only the roles granted to the listed identities count. A Crowd or OIDC provider with enableBasicAuth: true counts as a provider without an email limit, because Basic Authentication bypasses the limits.

      • spec.allowedIdentities.emailDomains
        array of strings

        Email domains this provider may assert, without the @.

        Matched exactly against the part of the email after the last @; subdomains must be listed explicitly.

        • Element of the array
          string
      • spec.allowedIdentities.emails
        array of strings

        Exact email addresses this provider may assert.

        Compared case-insensitively.

        • Element of the array
          string
      • spec.allowedIdentities.groups
        array of strings

        Group names this provider may assert, with the groupPrefix in front when it is set.

        Applied on top of the provider-specific group filters (allowedGroups, groups, teams, orgs[].teams), if any.

        • Element of the array
          string

          Length: 1..256

    • spec.bitbucketCloud
      object

      Parameters of the Bitbucket Cloud (intended for the type: BitbucketCloud).

      • spec.bitbucketCloud.clientID
        string

        Required value

        Team application ID from BitbucketCloud (Key).

      • spec.bitbucketCloud.clientSecret
        string

        Required value

        Team application secret key from BitbucketCloud.

      • spec.bitbucketCloud.includeTeamGroups
        boolean

        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

      • spec.bitbucketCloud.teams
        array of strings

        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 groups claim (similar to other providers).

    • spec.crowd
      object

      Parameters of the Crowd (intended for the type: Crowd).

      • spec.crowd.baseURL
        string

        Required value

        Base part of Atlassian Crowd URL.

        Example:

        baseURL: https://crowd.example.com/crowd
        
      • spec.crowd.clientID
        string

        Required value

        Application ID from Atlassian Crowd (Application Name).

      • spec.crowd.clientSecret
        string

        Required value

        Application secret key from Atlassian Crowd (Password).

      • spec.crowd.enableBasicAuth
        boolean

        Enables Basic Authentication to the Kubernetes API server with the Crowd user’s username and password.

        Works only when the apiserver.publishAPI parameter of the control-plane-manager module is enabled. Only one DexProvider in the cluster can have enableBasicAuth enabled.

        The parameter cannot be turned on while twoFactor.providerTypes includes Crowd, because Basic Authentication has no page for the second factor.

        Basic Authentication bypasses spec.allowedIdentities. Therefore only a SuperAdmin can 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.

      • spec.crowd.groups
        array of strings

        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.

      • spec.crowd.usernamePrompt
        string

        Prompt for username field.

        Default: Crowd username

    • spec.displayName
      string

      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.

    • spec.enabled
      boolean

      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

    • spec.github
      object

      Parameters of the GitHub provider (intended for the type: Github case only).

      • spec.github.clientID
        string

        Required value

        Organization application ID from GitHub.

      • spec.github.clientSecret
        string

        Required value

        Organization application secret key from GitHub.

      • spec.github.orgs
        array of objects

        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.

        • spec.github.orgs.name
          string

          Required value

          Name of organization.

        • spec.github.orgs.teams
          array of strings

          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.

      • spec.github.teamNameField
        string

        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: name

        Allowed values: name, slug, both

      • spec.github.useLoginAsID
        boolean

        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.

    • spec.gitlab
      object

      Parameters of the GitLab provider (intended for the type: Gitlab case only).

      • spec.gitlab.baseURL
        string

        Base part of GitLab URL.

        Example:

        baseURL: https://gitlab.example.com
        
      • spec.gitlab.clientID
        string

        Required value

        Application ID from GitLab.

      • spec.gitlab.clientSecret
        string

        Required value

        Application secret key from GitLab.

      • spec.gitlab.groups
        array of strings

        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;

      • spec.gitlab.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.gitlab.useLoginAsID
        boolean

        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.

    • spec.groupPrefix
      string

      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 example corp-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.groups must 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.groups and ldap.groupSearch) take the names of the identity provider, without the prefix.

      The prefix cannot start with system:, which the Kubernetes API server reserves, or with peering:, which is reserved for the ServiceAccounts of the d8-peering namespace. It cannot be set together with enableBasicAuth of an OIDC or Crowd provider, 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..64

      Example:

      groupPrefix: 'corp-ldap:'
      
    • spec.ldap
      object

      Parameters of the LDAP.

      • spec.ldap.bindDN
        string

        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
        
      • spec.ldap.bindPW
        string

        Password of the service account set in bindDN.

        Example:

        bindPW: password
        
      • spec.ldap.enableBasicAuth
        boolean

        Enables Basic Authentication to the Kubernetes API server with the LDAP user’s username and password.

        Works only when the apiserver.publishAPI parameter of the control-plane-manager module is enabled. Only one DexProvider in the cluster can have enableBasicAuth enabled.

        The parameter cannot be turned on while twoFactor.providerTypes includes LDAP, 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.

      • spec.ldap.groupSearch
        object

        Group search queries for groups given a user entry. Details

        • spec.ldap.groupSearch.baseDN
          string

          Required value

          BaseDN to start the search from.

          Example:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.groupSearch.filter
          string

          Optional filter to apply when searching the directory.

          Example:

          filter: "(objectClass=person)"
          
        • spec.ldap.groupSearch.nameAttr
          string

          Required value

          Represents group name.

          Example:

          nameAttr: name
          
        • spec.ldap.groupSearch.userMatchers
          array of objects

          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.

          • spec.ldap.groupSearch.userMatchers.groupAttr
            string

            Required value

            The name of the attribute that stores the group member names.

            Example:

            groupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.recursionGroupAttr
            string

            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 example member.

            Dex makes one more search for every group of every level at each sign-in and each refresh of the tokens, so keep baseDN and filter of groupSearch narrow.

            Example:

            recursionGroupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.userAttr
            string

            Required value

            The name of the attribute that stores the user name.

            Example:

            userAttr: uid
            
      • spec.ldap.host
        string

        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
        
      • spec.ldap.insecureNoSSL
        boolean

        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, and rootCAData: when insecureNoSSL is true, TLS is disabled and those settings have no effect.

        Default: false

      • spec.ldap.insecureSkipVerify
        boolean

        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 insecureNoSSL is true.

        Default: false

      • spec.ldap.kerberos
        object

        Optional Kerberos (SPNEGO) SSO settings for LDAP.

        • spec.ldap.kerberos.enabled
          boolean

          Enable Kerberos SPNEGO flow for this LDAP provider.

          Default: false

        • spec.ldap.kerberos.expectedRealm
          string

          Optional realm to require (case-insensitive).

        • spec.ldap.kerberos.fallbackToPassword
          boolean

          If true, in the absence of/incorrect Authorization: Negotiate header, a login/password form will be displayed instead of a 401 response with WWW-Authenticate: Negotiate.

          Default: false

        • spec.ldap.kerberos.keytabSecretName
          string

          Name of the Secret in the d8-user-authn namespace containing the krb5.keytab key to mount for Dex.

          Required when enabled is true.

        • spec.ldap.kerberos.krb5ConfConfigMapName
          string

          Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this ConfigMap.

        • spec.ldap.kerberos.krb5ConfSecretName
          string

          Not used. Dex validates Kerberos tickets with the keytab only, and the module does not mount this Secret.

        • spec.ldap.kerberos.usernameFromPrincipal
          string

          How to map Kerberos principal to LDAP username.

          Default: Localpart

          Allowed values: Localpart, SAMAccountName, UserPrincipalName

      • spec.ldap.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Has no effect when insecureNoSSL is true.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.ldap.startTLS
        boolean

        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

      • spec.ldap.userSearch
        object

        Required value

        User search maps a username and password entered by a user to a LDAP entry. Details…

        • spec.ldap.userSearch.baseDN
          string

          Required value

          BaseDN to start the search from.

          Example:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.userSearch.emailAttr
          string

          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
          
        • spec.ldap.userSearch.filter
          string

          Optional filter to apply when searching the directory.

          Example:

          filter: "(objectClass=person)"
          
        • spec.ldap.userSearch.idAttr
          string

          Required value

          LDAP attribute that will be matched to Dex user id entry.

          The binary GUID attributes of Active Directory, objectGUID and mS-DS-ConsistencyGuid, are supported: the user ID is then the GUID in its string form, for example 7ed41c2b-e283-4b10-9cb8-a6e7d1f39a4c.

          Example:

          idAttr: uid
          
        • spec.ldap.userSearch.nameAttr
          string

          LDAP attribute that will be matched to Dex user name entry. No default value provided.

          Example:

          nameAttr: name
          
        • spec.ldap.userSearch.username
          string

          Username attribute used for comparing user entries. This will be translated and combined with the other filter as “(=)".

          Example:

          username: uid
          
        • spec.ldap.userSearch.usernames
          array of strings

          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 with usernameFromPrincipal. 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 username or usernames.

          Example:

          usernames:
          - uid
          - mail
          
          • Element of the array
            string

            Pattern: ^[^\r\n]*$

            Length: 1..256

      • spec.ldap.usernamePrompt
        string

        The attribute to display in the provided password prompt. If unset, will display “LDAP Username”.

        Default: LDAP username

        Example:

        usernamePrompt: SSO Username
        
    • spec.oidc
      object

      Parameters of the OIDC (intended for the type: OIDC).

      • spec.oidc.allowedGroups
        array of strings

        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.

      • spec.oidc.basicAuthUnsupported
        boolean

        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

      • spec.oidc.claimMapping
        object

        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.

        • spec.oidc.claimMapping.email
          string

          The claim to use as the user email.

          Default: email

        • spec.oidc.claimMapping.groups
          string

          The claim to use as the user groups.

          Default: groups

        • spec.oidc.claimMapping.preferred_username
          string

          The claim to use as the user preferred username.

          Default: preferred_username

      • spec.oidc.claimMappingOverride
        boolean

        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 email claim in the id_token, the claimMapping.email will be used.

        Default: false

      • spec.oidc.clientID
        string

        Required value

        OIDC issuer application ID.

      • spec.oidc.clientSecret
        string

        Required value

        OIDC issuer application secret key.

      • spec.oidc.enableBasicAuth
        boolean

        Enables Basic Authentication to the Kubernetes API server with the OIDC user’s username and password.

        Works only when the apiserver.publishAPI parameter of the control-plane-manager module is enabled. Only one DexProvider in the cluster can have enableBasicAuth enabled.

        Basic Authentication bypasses spec.allowedIdentities. Therefore only a SuperAdmin can 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.

      • spec.oidc.getUserInfo
        boolean

        Request additional info about the authenticated user.

        See UserInfo endpoint.

        Default: false

      • spec.oidc.insecureSkipEmailVerified
        boolean

        Allow authentication for clients without verified email address.

        Default: false

      • spec.oidc.insecureSkipVerify
        boolean

        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

      • spec.oidc.issuer
        string

        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
        
      • spec.oidc.promptType
        string

        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

      • spec.oidc.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.oidc.scopes
        array of strings

        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"]

        • Element of the array
          string

          Pattern: ^\S+$

      • spec.oidc.upstreamLogout
        boolean

        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

      • spec.oidc.userIDKey
        string

        The claim to use as the user id.

        Default: sub

      • spec.oidc.userNameKey
        string

        The claim to use as the user name.

        Default: name

    • spec.saml
      object

      Parameters of a SAML provider (intended for the type: SAML).

      • spec.saml.allowedGroups
        array of strings

        If set, only members of at least one of the listed groups will be allowed to log in.

      • spec.saml.emailAttr
        string

        SAML attribute to map to the email claim.

        Default: email

      • spec.saml.entityIssuer
        string

        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.

      • spec.saml.filterGroups
        boolean

        If true, the connector will filter the groups claim to only include groups from the allowedGroups list.

        Default: false

      • spec.saml.groupsAttr
        string

        SAML attribute to map to the groups claim.

      • spec.saml.groupsDelim
        string

        Delimiter to split the groups attribute value if it is a single string.

      • spec.saml.insecureSkipSignatureValidation
        boolean

        Skip signature validation of SAML responses. This is insecure and should only be used for testing.

        Default: false

      • spec.saml.nameIDPolicyFormat
        string

        The NameIDPolicy format to request from the IdP.

        If not set, Dex requests persistent.

        A UserOperation Lock with spec.target applies to the user ID, which Dex takes from the NameID. Use persistent or emailAddress for such a lock to work. With transient, 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

      • spec.saml.redirectURI
        string

        Callback URI.

        Overrides the default callback URL. Should be set to https://<dex-domain>/callback.

      • spec.saml.rootCAData
        string

        A CA chain to validate the provider in PEM format.

        Example:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.saml.ssoIssuer
        string

        Issuer value expected in the SAML response from the IdP.

        If not set, the Issuer of the response is not checked.

      • spec.saml.ssoURL
        string

        Required value

        SSO URL used for POST value.

        Example:

        ssoURL: https://idp.example.com/saml/sso
        
      • spec.saml.usernameAttr
        string

        SAML attribute to map to the username claim.

        Default: name

    • spec.tokenExchange
      object

      Settings of token exchange (RFC 8693) through the provider. Dex exchanges an ID token of the provider’s issuer for its own token. Only OIDC and Gitlab providers 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.

      • spec.tokenExchange.enabled
        boolean

        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-authn sets it once on every existing OIDC and Gitlab provider. It sets true on all of them if at least one DexClient has the dexclient.deckhouse.io/allow-access-to-kubernetes: "true" annotation, and false on 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.

    • spec.type
      string

      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.

  • spec
    object

    Required value

    • spec.members
      array of objects

      Required value

      List of group members.

      • spec.members.kind
        string

        Required value

        Type of a group member.

        Allowed values: User, Group

      • spec.members.name
        string

        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.

    • spec.name
      string

      Required value

      Unique group name that appears in the token groups claim and in RBAC subjects. Not metadata.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).

  • spec
    object

    Required value

    • spec.allowedIdentities
      object

      Limits the identities this provider may assert, as in DexProvider. Dex refuses a subject whose email is outside emails and emailDomains when either is set, and keeps only the groups listed in groups when it is set.

      • spec.allowedIdentities.emailDomains
        array of strings

        Allowed email domains.

      • spec.allowedIdentities.emails
        array of strings

        Allowed email addresses.

      • spec.allowedIdentities.groups
        array of strings

        Allowed groups. The other groups are removed from the subject.

    • spec.audiences
      array of objects

      Required value

      Audiences a token is accepted for. A token is accepted if its aud claim matches at least one entry.

      • spec.audiences.exact
        string

        Value that aud must equal.

      • spec.audiences.prefix
        string

        Prefix that aud must start with.

    • spec.claimValidation
      array of objects

      Claim values a token must carry.

      A string claim must equal equals. A boolean or a number must equal equals when written as a string. A list must contain equals.

      • spec.claimValidation.claim
        string

        Required value

        Name of the claim to check.

      • spec.claimValidation.equals
        string

        Required value

        Value the claim must have.

    • spec.clients
      array of objects

      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 allowedProviders does not name the provider.

      • spec.clients.dexClient
        object

        Required value

        DexClient that may exchange tokens. Its client ID is dex-client-<DEXCLIENT_NAME>@<DEXCLIENT_NAMESPACE>.

        • spec.clients.dexClient.name
          string

          Required value

          Name of the DexClient.

        • spec.clients.dexClient.namespace
          string

          Required value

          Namespace of the DexClient.

    • spec.identity
      object

      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 email is set.

      • spec.identity.email
        object

        Email of the subject, made of prefix and the value of the string claim claim. The prefix is required and ends with a colon.

        • spec.identity.email.claim
          string

          Required value

          Name of the string claim whose value follows the prefix.

        • spec.identity.email.prefix
          string

          Prefix added to the value of the claim. It is required and ends with a colon, such as ci:.

      • spec.identity.groups
        array of objects

        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. Then prefix is added to every remaining value. It is required and ends with a colon.

        • spec.identity.groups.claim
          string

          Required value

          Name of the string or list claim that holds the groups.

        • spec.identity.groups.prefix
          string

          Prefix added to every group. It is required and ends with a colon, such as ci:.

        • spec.identity.groups.trimPrefix
          string

          Prefix that group values must start with. It is removed from them, and values without it are dropped.

      • spec.identity.username
        object

        Required value

        User name of the subject, made of prefix and the value of the string claim claim. The prefix is required and ends with a colon.

        • spec.identity.username.claim
          string

          Required value

          Name of the string claim whose value follows the prefix.

        • spec.identity.username.prefix
          string

          Prefix added to the value of the claim. It is required and ends with a colon, such as ci:.

    • spec.issuer
      string

      Required value

      Issuer of the tokens. It must equal the iss claim of a token.

      An https URL without a query or fragment.

      Example:

      issuer: https://gitlab.example.com
      
    • spec.keys
      object

      Required value

      Source of the keys that sign the tokens, either the discovery document of the issuer or public keys given here.

      • spec.keys.discovery
        object

        Settings for reading the keys from the discovery document of the issuer. Dex reads it at the first exchange and again after a failure.

        • spec.keys.discovery.caData
          string

          PEM bundle of the CA that the certificate of the issuer chains to, in addition to the system roots.

        • spec.keys.discovery.url
          string

          HTTPS address of the discovery document.

          If not set, <ISSUER>/.well-known/openid-configuration is used, where <ISSUER> is the value of spec.issuer.

      • spec.keys.jwks
        object

        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 kid header is verified with the key of that kid only, even when the set has one key.

        • spec.keys.jwks.keys
          array of objects

          Required value

          Public keys in JWK format.

          • spec.keys.jwks.keys.kty
            string

            Required value

            Key type, such as RSA or EC.

    • spec.subjectTokenMaxLifetime
      string

      Longest time a token may be valid, counted from iat to exp, or from now to exp for a token without iat.

      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 24h or 1h30m.

      Default: 24h

      Length: 2..16

  • status
    object

    Status of the provider.

    While metadata.deletionTimestamp is set, the provider is being revoked, and a client must stop using the tokens it got through it.

    • status.conditions
      array of objects

      Conditions of the provider. The Ready condition shows whether the provider exchanges tokens, and its reason tells why it does not.

      • status.conditions.lastTransitionTime
        string

        Time the status last changed.

      • status.conditions.message
        string

        Details of the status.

      • status.conditions.observedGeneration
        integer

        Generation of the object that the condition was set for.

      • status.conditions.reason
        string

        Reason for the status, such as PrefixConflict.

      • status.conditions.status
        string

        Required value

        Status of the condition, True, False or Unknown.

      • status.conditions.type
        string

        Required value

        Type of the condition, such as Ready.

    • status.connectorID
      string

      ID of the Dex connector of the provider. Use it as connector_id in the exchange request. Tokens issued through it carry it in the user-authn.deckhouse.io/dex-provider extra of the user.

    • status.observedGeneration
      integer

      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.

  • spec
    object

    Empty. UserAccount is controller-owned and has no user-editable specification.

    Do not create UserAccount objects. The controller projects it from Dex.

  • status
    object

    Observed account state projected from Dex.

    This is a Deckhouse web UI view only and does not store credentials or connector secrets.

    • status.connectorID
      string

      Dex connector identifier.

      local for local accounts; otherwise the DexProvider name.

    • status.email
      string

      Account email as reported by Dex.

    • status.expireAt
      string

      Account expiration time, in RFC3339 format.

    • status.groups
      array of strings

      Groups associated with the account.

    • status.incorrectLoginAttempts
      integer

      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.applyToConnectors module parameter.

      Allowed values: 0 <= X

    • status.kind
      string

      Account kind.

      Possible values:

      • Local: Dex Password (static user).
      • External: Federated identity from a connector.

      Allowed values: Local, External

    • status.lastLogin
      string

      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 enableBasicAuth updates 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.

    • status.locked
      boolean

      Whether the account is currently locked.

    • status.lockedByAdministrator
      boolean

      Whether the current lock was set by an administrator (as opposed to an automatic password-policy lockout).

      This does not make the lock permanent. lockedUntil still defines when it expires.

    • status.lockedUntil
      string

      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.

    • status.providerType
      string

      External identity provider type.

      Equals spec.type of the DexProvider, for example LDAP, Crowd, OIDC, SAML, or Github.

      Empty for local accounts.

    • status.sessions
      array of objects

      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 sessions of Dex are enabled, together with the applications whose refresh tokens are bound to its session (the DexAuthenticator objects, and DexClient objects with refreshTokenLifetime: 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 Logout type with its id in logout.session (a browser) or logout.grant (a refresh token).

      • status.sessions.clients
        array of strings

        Dex clients (applications) signed in on the device.

      • status.sessions.endsAt
        string

        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.

        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.

      • status.sessions.id
        string

        Required value

        Identifier of the device: the identifier of the session of Dex (the sid claim of its tokens) for a browser, the identifier of the refresh token for other devices.

      • status.sessions.ipAddress
        string

        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

      • status.sessions.kind
        string

        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

      • status.sessions.knownSince
        string

        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.

      • status.sessions.lastActivity
        string

        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.

      • status.sessions.signedInAt
        string

        Time the device signed in, in RFC3339 format.

      • status.sessions.userAgent
        string

        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

    • status.sessionsTruncated
      boolean

      Whether the account has more devices than sessions lists. The least recently active ones are not listed.

    • status.twoFactor
      object

      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.

      • status.twoFactor.confirmed
        boolean

        Whether the account has what methods and require ask 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.

      • status.twoFactor.enrolled
        boolean

        Whether the account has what methods and require ask 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.

      • status.twoFactor.methods
        array of strings

        Second factors the settings ask the users of the type of provider of the account for (twoFactor.methods of the module, or its providerTypeOverrides entry for the type).

        Absent when 2FA is off or does not cover the type.

        • Element of the array
          string

          Allowed values: TOTP, WebAuthn

      • status.twoFactor.require
        string

        How the two methods combine. With Any, the user passes one of them, with All, both. Absent with one method.

        Allowed values: Any, All

      • status.twoFactor.totp
        object

        TOTP secret of the account. Absent when there is none.

        A UserOperation of the Reset2FA type removes it, unless spec.reset2FA.methods lists only WebAuthn.

        • status.twoFactor.totp.confirmed
          boolean

          Whether the user has entered a code for the secret.

      • status.twoFactor.webAuthn
        object

        WebAuthn credentials (security keys) of the account. Absent when there is none.

        A UserOperation of the Reset2FA type removes them, unless spec.reset2FA.methods lists only TOTP.

        • status.twoFactor.webAuthn.credentials
          integer

          Number of registered security keys.

        • status.twoFactor.webAuthn.maxCredentials
          integer

          How many credentials the account may register (twoFactor.webAuthn.maxCredentials of the module).

    • status.userID
      string

      Unique user identifier from Dex.

    • status.userRef
      string

      Name of the related User resource.

      Set for local accounts.

    • status.username
      string

      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.

  • spec
    object

    Required value

    • spec.initiatorType
      string

      Indicates who initiated the operation. Possible values:

      • admin: By an administrator (e.g. via d8 iam user CLI 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).
    • spec.lock
      object

      Parameters for locking the user.

      • spec.lock.for
        string

        Required value

        Lock duration as a Go-style duration string (30s, 10m, 1h, 2h30m, 7d), or permanent for an indefinite lock released only by Unlock. 1d equals 24h.

        Pattern: ^(permanent|([0-9]+(\.[0-9]+)?(s|m|h|d))+)$

    • spec.logout
      object

      Narrows a Logout down. Without it, Logout ends every session of the user.

      Set at most one of the fields. session and exceptSession apply to Dex browser sessions.

      • spec.logout.exceptGrant
        string

        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}$

      • spec.logout.exceptSession
        string

        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}$

      • spec.logout.grant
        string

        ID of the refresh token to revoke: a device signed in without a browser session of Dex, such as a kubeconfig. It is the id of a device of the Grant kind in status.sessions of the UserAccount and the d8_gid claim 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 the the user has no such grant message.

        Pattern: ^[a-z2-7]{1,64}$

      • spec.logout.session
        string

        ID of the browser session to end (the sid claim 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 the the user has no such session message.

        Pattern: ^[a-z2-7]{1,64}$

    • spec.reset2FA
      object

      Narrows a Reset2FA down. Without it, Reset2FA removes every second factor of the user.

      • spec.reset2FA.methods
        array of strings

        Second factors to remove: TOTP, the secret of the authenticator application, and WebAuthn, 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.

        • Element of the array
          string

          Allowed values: TOTP, WebAuthn

    • spec.resetPassword
      object

      Parameters for password reset.

      • spec.resetPassword.newPasswordHash
        string

        Bcrypt hash of the new password, without Base64 encoding.

      • spec.resetPassword.requirePasswordChange
        boolean

        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

    • spec.target
      object

      Identifier of an account of an external authentication provider, by email.

      The Lock, Unlock, Logout, and Reset2FA operations against target apply to the Dex account (UserIdentity object) of the user whose email at the last sign-in was email. connectorID and userID narrow 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 set connectorID, and userID if 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 by spec.user only.

      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 nameIDPolicyFormat set to persistent or emailAddress or not set. With transient, 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: user or target.

      • spec.target.connectorID
        string

        ID of the DexProvider (connector) through which the user logs in.

        Examples:

        connectorID: my-ldap
        
        connectorID: my-crowd
        
      • spec.target.email
        string

        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
        
      • spec.target.userID
        string

        ID of the user that the provider returns at sign-in (userID of 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
        
    • spec.type
      string

      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. Without logout, 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

    • spec.user
      string

      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: user or target.

      Example:

      user: jane.doe
      
  • status
    object
    • status.completedAt
      string

      Time when the operation was completed, in RFC 3339 format (e.g. 2025-01-15T10:30:00Z). Empty until the operation finishes processing.

    • status.message
      string

      Optional message about the result or failure of the operation.

    • status.phase
      string

      Current phase of the operation. Possible values:

      • Succeeded: Operation was completed successfully.
      • Failed: Operation failed.

      Allowed values: Succeeded, Failed

    • status.revocation
      object

      What the operation revoked. Set by Lock, ResetPassword, Reset2FA, and Logout.

      • status.revocation.authSessionsDeleted
        integer

        Number of Dex AuthSession objects (browser sessions) of the user the operation deleted.

      • status.revocation.generation
        integer

        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.

      • status.revocation.name
        string

        Name of the Dex Revocation object the operation wrote, or of the first of them.

      • status.revocation.refreshTokensDeleted
        integer

        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.

  • spec
    object

    Required value

    • spec.initiatorType
      string

      Indicates who initiated the operation. Possible values:

      • admin: By an administrator.
      • system: Reserved. No component sets this value.
      • self: By the user.
    • spec.lock
      object

      Parameters for locking the user.

      • spec.lock.for
        string

        Required value

        Lock duration as a Go-style duration string (30s, 10m, 1h, 2h30m, 7d), or permanent for an indefinite lock released only by Unlock. 1d equals 24h.

        Pattern: ^(permanent|([0-9]+(\.[0-9]+)?(s|m|h|d))+)$

    • spec.resetPassword
      object

      Parameters for password reset.

      • spec.resetPassword.newPasswordHash
        string

        Bcrypt hash of the new password.

    • spec.type
      string

      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

    • spec.user
      string

      Required value

      Name (username) of the target User resource.

      Example:

      user: jane.doe
      
  • status
    object
    • status.completedAt
      string

      Time when the operation was completed.

    • status.message
      string

      Optional message about the result or failure of the operation.

    • status.phase
      string

      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.

Creating a user

  • spec
    object

    Required value

    • spec.email
      string

      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 email value as the User subject 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..150

      Example:

      email: user@domain.com
      
    • spec.groups
      Deprecated
      array of strings

      Static user groups.

      Since the parameter has been deprecated, use the Group resource to add users to groups.

    • spec.password
      string

      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 with d8 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 edit does not update Dex credentials and will be rejected. To reset the password, use the UserOperation resource (or d8 iam user).

      Example:

      password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H
      
    • spec.requirePasswordChangeOnFirstLogin
      boolean

      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.

    • spec.ttl
      string

      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 expireAt date will not be updated if you change it again.

      Pattern: ^([0-9]+h([0-9]+m)?|[0-9]+m)$

      Example:

      ttl: 24h
      
    • spec.userID
      Deprecated
      string

      Deprecated. Ignored if set. Dex Password.userID is User.metadata.name.

  • status
    object
    • status.expireAt
      string

      User account expiration time. Set only when spec.ttl is set. At this time the User is deleted and removed from all Groups.

    • status.groups
      array of strings

      Groups the user belongs to, computed from Group membership. Values are Group.spec.name.

    • status.lock
      object

      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.

      • status.lock.message
        string

        Human-readable explanation of the lock reason.

      • status.lock.reason
        string

        Machine-readable reason for the account lock. Used for programmatic checks and policy enforcement.

        Allowed values: PasswordPolicyLockout, LockedByAdministrator

      • status.lock.state
        boolean

        Indicates whether the user account is currently locked.

        • true — account is locked.
        • false — account is active.
      • status.lock.until
        string

        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.

Creating a user

  • spec
    object

    Required value

    • spec.email
      string

      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 email value as the User subject 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..150

      Example:

      email: user@domain.com
      
    • spec.groups
      Deprecated
      array of strings

      Static user groups.

      Since the parameter has been deprecated, use the Group resource to add users to groups.

    • spec.password
      string

      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 with d8 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 edit does not update Dex credentials and will be rejected. To reset the password, use the UserOperation resource (or d8 iam user).

      Example:

      password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H
      
    • spec.requirePasswordChangeOnFirstLogin
      boolean

      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.

    • spec.ttl
      string

      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 expireAt date will not be updated if you change it again.

      Pattern: ^([0-9]+h([0-9]+m)?|[0-9]+m)$

      Example:

      ttl: 24h
      
    • spec.userID
      string

      Deprecated. Ignored if set. Dex Password.userID is User.metadata.name.

      Example:

      userID: '08a8684b-db88-4b73-90a9-3cd1661f5466'
      
  • status
    object
    • status.expireAt
      string

      User account expiration time. Set only when spec.ttl is set. At this time the User is deleted and removed from all Groups.

    • status.groups
      array of strings

      Groups the user belongs to, computed from Group membership. Values are Group.spec.name.

    • status.lock
      object

      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.

      • status.lock.message
        string

        Human-readable explanation of the lock reason.

      • status.lock.reason
        string

        Machine-readable reason for the account lock. Used for programmatic checks and policy enforcement.

        Allowed values: PasswordPolicyLockout, LockedByAdministrator

      • status.lock.state
        boolean

        Indicates whether the user account is currently locked.

        • true — account is locked.
        • false — account is active.
      • status.lock.until
        string

        The time until which the user is locked, in RFC3339 format. After this time, the account lock will be automatically lifted.