The user-authn module: Custom Resources

Defines the configuration for connecting a third-party provider. With it, you can flexibly configure the integration of the account directory with Kubernetes.

• specobject

  Required value

  • spec.bitbucketCloudobject

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

    • spec.bitbucketCloud.clientIDstring

      Required value

      Team application ID from BitbucketCloud (Key).

    • spec.bitbucketCloud.clientSecretstring

      Required value

      Team application secret key from BitbucketCloud.

    • spec.bitbucketCloud.includeTeamGroupsboolean

      Optional parameter to include team groups.

      If enabled, the groups claim of dex id_token will looks like this:

      ["my_team", "my_team/administrators", "my_team/members"]
      

      Default: false

    • spec.bitbucketCloud.teamsarray 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.crowdobject

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

    • spec.crowd.baseURLstring

      Required value

      Base part of Attlassian Crowd URL.

      Example:

      baseURL: https://crowd.example.com/crowd
      

    • spec.crowd.clientIDstring

      Required value

      Application ID from Atlassian Crowd (Application Name).

    • spec.crowd.clientSecretstring

      Required value

      Application secret key from Atlassian Crowd (Password).

    • spec.crowd.enableBasicAuthboolean

      Enables basic authorization for the Kubernetes API server.

      The username and password of the user from the application created in Crowd are used as credentials for basic authorization (you can enable it only if there is just one provider of the Crowd type). Works only if the publishAPI is enabled.

      Authorization and group data obtained from Crowd are stored in the cache for 10 seconds.

    • spec.crowd.groupsarray 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.usernamePromptstring

      Prompt for username field.

      Default: "Crowd username"

  • spec.displayNamestring

    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.githubobject

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

    • spec.github.clientIDstring

      Required value

      Organization application ID from GitHub.

    • spec.github.clientSecretstring

      Required value

      Organization application secret key from GitHub.

    • spec.github.orgsarray 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.namestring

        Required value

        Name of organization.

      • spec.github.orgs.teamsarray 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.teamNameFieldstring

      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’

      ‘name’ will be used by default.

      Default: "Name"

      Allowed values: Name, Slug, Both

    • spec.github.useLoginAsIDboolean

      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.gitlabobject

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

    • spec.gitlab.baseURLstring

      Base part of GitLab URL.

      Example:

      baseURL: https://gitlab.example.com
      

    • spec.gitlab.clientIDstring

      Required value

      Application ID from GitLab.

    • spec.gitlab.clientSecretstring

      Required value

      Application secret key from GitLab.

    • spec.gitlab.groupsarray 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.useLoginAsIDboolean

      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.ldapobject

    Parameters of the LDAP.

    • spec.ldap.bindDNstring

      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.bindPWstring

      Password for read-only service account. Please note that if the bind password contains a $, it has to be saved in an environment variable which should be given as the value to bindPW.

      Example:

      bindPW: password
      

    • spec.ldap.groupSearchobject

      Group search queries for groups given a user entry. Details

      • spec.ldap.groupSearch.baseDNstring

        Required value

        BaseDN to start the search from.

        Example:

        baseDN: cn=users,dc=example,dc=com
        

      • spec.ldap.groupSearch.filterstring

        Optional filter to apply when searching the directory.

        Example:

        filter: "(objectClass=person)"
        

      • spec.ldap.groupSearch.nameAttrstring

        Required value

        Represents group name.

        Example:

        nameAttr: name
        

      • spec.ldap.groupSearch.userMatchersarray 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.groupAttrstring

          Required value

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

          Example:

          groupAttr: member
          

        • spec.ldap.groupSearch.userMatchers.userAttrstring

          Required value

          The name of the attribute that stores the user name.

          Example:

          userAttr: uid
          

    • spec.ldap.hoststring

      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.insecureNoSSLboolean

      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. Equals to false by default.

      Default: false

    • spec.ldap.insecureSkipVerifyboolean

      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.ldap.rootCADatastring

      A CA chain to validate the provider in PEM format.

      Example:

      -----BEGIN CERTIFICATE-----
      MIIFaDC...
      -----END CERTIFICATE-----
      

    • spec.ldap.startTLSboolean

      When connecting to the server, connect using the ldap:// protocol then issue a StartTLS command. If unspecified, connections will use the ldaps:// protocol

      Default: false

    • spec.ldap.userSearchobject

      Required value

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

      • spec.ldap.userSearch.baseDNstring

        Required value

        BaseDN to start the search from.

        Example:

        baseDN: cn=users,dc=example,dc=com
        

      • spec.ldap.userSearch.emailAttrstring

        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.filterstring

        Optional filter to apply when searching the directory.

        Example:

        filter: "(objectClass=person)"
        

      • spec.ldap.userSearch.idAttrstring

        Required value

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

        Example:

        idAttr: uid
        

      • spec.ldap.userSearch.nameAttrstring

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

        Example:

        nameAttr: name
        

      • spec.ldap.userSearch.usernamestring

        Required value

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

        Example:

        username: uid
        

    • spec.ldap.usernamePromptstring

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

      Default: "LDAP username"

      Example:

      usernamePrompt: SSO Username
      

  • spec.oidcobject

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

    • spec.oidc.basicAuthUnsupportedboolean

      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.claimMappingobject

      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.emailstring

        The claim to use as the user email.

        Default: "email"

      • spec.oidc.claimMapping.groupsstring

        The claim to use as the user groups.

        Default: "groups"

      • spec.oidc.claimMapping.preferred_usernamestring

        The claim to use as the user preferred username.

        Default: "preferred_username"

    • spec.oidc.clientIDstring

      Required value

      OIDC issuer application ID.

    • spec.oidc.clientSecretstring

      Required value

      OIDC issuer application secret key.

    • spec.oidc.getUserInfoboolean

      Request additional info about the authenticated user.

      Learn more here…

      Default: false

    • spec.oidc.insecureSkipEmailVerifiedboolean

      Allow authentication for clients without verified email address.

      Default: false

    • spec.oidc.insecureSkipVerifyboolean

      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.issuerstring

      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.promptTypestring

      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.rootCADatastring

      A CA chain to validate the provider in PEM format.

      Example:

      -----BEGIN CERTIFICATE-----
      MIIFaDC...
      -----END CERTIFICATE-----
      

    • spec.oidc.scopesarray of strings

      List of additional scopes to request in token response.

      Default: ["openid","profile","email","groups","offline_access"]

    • spec.oidc.userIDKeystring

      The claim to use as the user id.

      Default: "sub"

    • spec.oidc.userNameKeystring

      The claim to use as the user name.

      Default: "name"

  • spec.typestring

    Required value

    Type of authentication provider.

    Allowed values: Github, Gitlab, BitbucketCloud, Crowd, OIDC, LDAP