Categorygithub.com/cockroachdb/cockroachpkgccloidcccl
package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
Versions
4
Dependencies
34
Dependents
4
Files
1.1k SLOC

# Constants

All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.
All cluster settings necessary for the OIDC feature.

# Variables

ConfigureOIDC attaches handlers to the server `mux` that can initiate and complete an OIDC authentication flow.
OIDCAuthClientTimeout is the client timeout for all the external calls made during OIDC authentication (e.g.
OIDCAutoLogin is a boolean that enables automatic redirection to OIDC auth in the DB Console.
OIDCButtonText is a string to display on the button in the DB Console to login with OIDC.
OIDCClaimJSONKey is the key of the claim to extract from the OIDC id_token.
OIDCClientID is the OIDC client id.
OIDCClientSecret is the OIDC client secret.
OIDCEnabled enables or disabled OIDC login for the DB Console.
OIDCGenerateClusterSSOTokenEnabled enables or disables generating JWT auth tokens for cluster SSO with OIDC.
OIDCGenerateClusterSSOTokenSQLHost stores the host name or address to be used for making SQL connections to the cluster, for display purposes only.
OIDCGenerateClusterSSOTokenSQLPort stores the port number to be used for making SQL connections to the cluster, for display purposes only.
OIDCGenerateClusterSSOTokenUseToken selects which OIDC callback token to use for cluster SSO.
OIDCPrincipalRegex is a regular expression to apply to the OIDC id_token claim value to conver it to a DB principal.
OIDCProviderURL is the location of the OIDC discovery document for the auth provider.
OIDCRedirectURL is the cluster URL to redirect to after OIDC auth completes.
OIDCScopes contains the list of scopes to request from the auth provider.

# Interfaces