AuthentikOAuth2Provider
goauthentik.io / v1alpha1
apiVersion: goauthentik.io/v1alpha1
kind: AuthentikOAuth2Provider
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
AuthentikOAuth2ProviderSpec defines the desired state of an Authentik OAuth2 Provider
accessCodeValidity
string
AccessCodeValidity defines how long access codes are valid
accessTokenValidity
string
AccessTokenValidity defines how long access tokens are valid
authorizationFlow
string required
AuthorizationFlow is the flow used for authorization
clientSecretRef object
ClientSecretRef references a Kubernetes Secret containing the client_secret.
If not provided, authentik will auto-generate the client secret.
The secret must contain a key named "client_secret".
name
string
name is unique within a namespace to reference a secret resource.
namespace
string
namespace defines the space within which the secret name must be unique.
clientType
string
ClientType is the OAuth2 client type (confidential or public)
enum:
confidential, public
includeClaimsInIdToken
boolean
IncludeClaimsInIDToken includes claims in the ID token
invalidationFlow
string required
InvalidationFlow is the flow used for token invalidation/logout
issuerMode
string
IssuerMode configures how the issuer is determined
enum:
global, per_provider
name
string required
Name is the display name of the provider
minLength:
1
propertyMappings
[]string
PropertyMappings is a list of property mapping UUIDs to apply
redirectUris
[]string required
RedirectURIs is the list of allowed redirect URIs
minItems:
1
refreshTokenValidity
string
RefreshTokenValidity defines how long refresh tokens are valid
scopes
[]string
Scopes is a list of scope names to enable for this provider
signingKey
string
SigningKey is the name of the certificate keypair used to sign tokens
subMode
string
SubMode configures what data is included in the subject claim
enum:
hashed_user_id, user_id, user_uuid, user_username, user_email, user_upnstatus object
AuthentikOAuth2ProviderStatus defines the observed state of AuthentikOAuth2Provider
clientId
string
ClientID is the OAuth2 client ID (for reference only)
clientSecret
string
ClientSecret is the OAuth2 client secret (for reference only, actual secret is in Kubernetes secret)
conditions []object
Conditions represent the latest available observations of the resource's state
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316
observedGeneration
integer
ObservedGeneration is the last observed generation of the resource
format:
int64
providerId
integer
ProviderID is the Authentik internal ID for the OAuth2 provider
format:
int32No matches. Try .spec.accessCodeValidity for an exact path