Skip to search

AuthentikStageAuthenticatorSms

goauthentik.io / v1alpha1

apiVersion: goauthentik.io/v1alpha1 kind: AuthentikStageAuthenticatorSms metadata: name: example
View raw schema
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
AuthentikStageAuthenticatorSmsSpec defines the desired state of AuthentikStageAuthenticatorSms
accountSid string required
AccountSid is the account SID (required)
auth string required
Auth is the auth token (required)
authPassword string
AuthPassword is the auth password
authType string
AuthType is the auth type
configureFlow string
ConfigureFlow is the flow used by an authenticated user to configure this Stage
friendlyName string
FriendlyName is the friendly name for the stage
fromNumber string required
FromNumber is the sender phone number (required)
mapping string
Mapping optionally modifies the payload being sent to custom providers
name string required
Name is the stage name (used as slug)
minLength: 1
provider string required
Provider is the SMS provider (required)
verifyOnly boolean
VerifyOnly uses the phone number only during enrollment
status object
AuthentikStageAuthenticatorSmsStatus defines the observed state of AuthentikStageAuthenticatorSms
conditions []object
Conditions represent the latest available observations of the stage'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: int64
minimum: 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: 1
maxLength: 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 reconciled generation
format: int64
stageUid string
StageUID is the authentik stage UUID

No matches. Try .spec.accountSid for an exact path