@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/src/models/AuthenticatorStaticStage.ts

@@ -39,25 +39,25 @@ export interface AuthenticatorStaticStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof AuthenticatorStaticStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof AuthenticatorStaticStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof AuthenticatorStaticStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof AuthenticatorStaticStage
      */

package/src/models/AuthenticatorTOTPStage.ts

@@ -45,25 +45,25 @@ export interface AuthenticatorTOTPStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof AuthenticatorTOTPStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof AuthenticatorTOTPStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof AuthenticatorTOTPStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof AuthenticatorTOTPStage
      */

package/src/models/AuthenticatorValidateStage.ts

@@ -57,25 +57,25 @@ export interface AuthenticatorValidateStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof AuthenticatorValidateStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof AuthenticatorValidateStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof AuthenticatorValidateStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof AuthenticatorValidateStage
      */
@@ -112,6 +112,10 @@ export interface AuthenticatorValidateStage {
     lastAuthThreshold?: string;
     /**
      * Enforce user verification for WebAuthn devices.
+     * 
+     * * `required` - Required
+     * * `preferred` - Preferred
+     * * `discouraged` - Discouraged
      * @type {UserVerificationEnum}
      * @memberof AuthenticatorValidateStage
      */

package/src/models/AuthenticatorValidateStageRequest.ts

@@ -82,6 +82,10 @@ export interface AuthenticatorValidateStageRequest {
     lastAuthThreshold?: string;
     /**
      * Enforce user verification for WebAuthn devices.
+     * 
+     * * `required` - Required
+     * * `preferred` - Preferred
+     * * `discouraged` - Discouraged
      * @type {UserVerificationEnum}
      * @memberof AuthenticatorValidateStageRequest
      */

package/src/models/BackendsEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `authentik.core.auth.InbuiltBackend` - User database + standard password
+ * * `authentik.core.auth.TokenBackend` - User database + app passwords
+ * * `authentik.sources.ldap.auth.LDAPBackend` - User database + LDAP password
  * @export
  */
 export const BackendsEnum = {

package/src/models/BindingTypeEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `REDIRECT` - Redirect Binding
+ * * `POST` - POST Binding
+ * * `POST_AUTO` - POST Binding with auto-confirmation
  * @export
  */
 export const BindingTypeEnum = {

package/src/models/BlueprintInstanceStatusEnum.ts

@@ -14,7 +14,11 @@
 
 
 /**
- * 
+ * * `successful` - Successful
+ * * `warning` - Warning
+ * * `error` - Error
+ * * `orphaned` - Orphaned
+ * * `unknown` - Unknown
  * @export
  */
 export const BlueprintInstanceStatusEnum = {

package/src/models/CapabilitiesEnum.ts

@@ -14,7 +14,10 @@
 
 
 /**
- * 
+ * * `can_save_media` - Can Save Media
+ * * `can_geo_ip` - Can Geo Ip
+ * * `can_impersonate` - Can Impersonate
+ * * `can_debug` - Can Debug
  * @export
  */
 export const CapabilitiesEnum = {

package/src/models/CaptchaStage.ts

@@ -39,25 +39,25 @@ export interface CaptchaStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof CaptchaStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof CaptchaStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof CaptchaStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof CaptchaStage
      */

package/src/models/CertificateKeyPair.ts

@@ -32,49 +32,49 @@ export interface CertificateKeyPair {
      */
     name: string;
     /**
-     * 
+     * Get certificate Hash (SHA256)
      * @type {string}
      * @memberof CertificateKeyPair
      */
     readonly fingerprintSha256: string | null;
     /**
-     * 
+     * Get certificate Hash (SHA1)
      * @type {string}
      * @memberof CertificateKeyPair
      */
     readonly fingerprintSha1: string | null;
     /**
-     * 
+     * Get certificate expiry
      * @type {Date}
      * @memberof CertificateKeyPair
      */
     readonly certExpiry: Date | null;
     /**
-     * 
+     * Get certificate subject as full rfc4514
      * @type {string}
      * @memberof CertificateKeyPair
      */
     readonly certSubject: string | null;
     /**
-     * 
+     * Show if this keypair has a private key configured or not
      * @type {boolean}
      * @memberof CertificateKeyPair
      */
     readonly privateKeyAvailable: boolean;
     /**
-     * 
+     * Get the private key's type, if set
      * @type {string}
      * @memberof CertificateKeyPair
      */
     readonly privateKeyType: string | null;
     /**
-     * 
+     * Get URL to download certificate
      * @type {string}
      * @memberof CertificateKeyPair
      */
     readonly certificateDownloadUrl: string;
     /**
-     * 
+     * Get URL to download private key
      * @type {string}
      * @memberof CertificateKeyPair
      */

package/src/models/ChallengeChoices.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `native` - NATIVE
+ * * `shell` - SHELL
+ * * `redirect` - REDIRECT
  * @export
  */
 export const ChallengeChoices = {

package/src/models/ClientTypeEnum.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `confidential` - Confidential
+ * * `public` - Public
  * @export
  */
 export const ClientTypeEnum = {

package/src/models/ConsentStage.ts

@@ -45,25 +45,25 @@ export interface ConsentStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof ConsentStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof ConsentStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof ConsentStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof ConsentStage
      */

package/src/models/ConsentStageModeEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `always_require` - Always Require
+ * * `permanent` - Permanent
+ * * `expiring` - Expiring
  * @export
  */
 export const ConsentStageModeEnum = {

package/src/models/DeniedActionEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `message_continue` - Message Continue
+ * * `message` - Message
+ * * `continue` - Continue
  * @export
  */
 export const DeniedActionEnum = {

package/src/models/DenyStage.ts

@@ -39,25 +39,25 @@ export interface DenyStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof DenyStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof DenyStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof DenyStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof DenyStage
      */

package/src/models/Device.ts

@@ -20,19 +20,19 @@ import { exists, mapValues } from '../runtime';
  */
 export interface Device {
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof Device
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof Device
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof Device
      */
@@ -50,7 +50,7 @@ export interface Device {
      */
     name: string;
     /**
-     * 
+     * Get type of device
      * @type {string}
      * @memberof Device
      */

package/src/models/DeviceClassesEnum.ts

@@ -14,7 +14,11 @@
 
 
 /**
- * 
+ * * `static` - Static
+ * * `totp` - TOTP
+ * * `webauthn` - WebAuthn
+ * * `duo` - Duo
+ * * `sms` - SMS
  * @export
  */
 export const DeviceClassesEnum = {

package/src/models/DigestAlgorithmEnum.ts

@@ -14,7 +14,10 @@
 
 
 /**
- * 
+ * * `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1
+ * * `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256
+ * * `http://www.w3.org/2001/04/xmldsig-more#sha384` - SHA384
+ * * `http://www.w3.org/2001/04/xmlenc#sha512` - SHA512
  * @export
  */
 export const DigestAlgorithmEnum = {

package/src/models/DigitsEnum.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `6` - 6 digits, widely compatible
+ * * `8` - 8 digits, not compatible with apps like Google Authenticator
  * @export
  */
 export const DigitsEnum = {

package/src/models/DockerServiceConnection.ts

@@ -44,19 +44,19 @@ export interface DockerServiceConnection {
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof DockerServiceConnection
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof DockerServiceConnection
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof DockerServiceConnection
      */

package/src/models/DummyPolicy.ts

@@ -38,31 +38,31 @@ export interface DummyPolicy {
      */
     executionLogging?: boolean;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof DummyPolicy
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof DummyPolicy
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof DummyPolicy
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof DummyPolicy
      */
     readonly metaModelName: string;
     /**
-     * 
+     * Return objects policy is bound to
      * @type {number}
      * @memberof DummyPolicy
      */

package/src/models/DummyStage.ts

@@ -39,25 +39,25 @@ export interface DummyStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof DummyStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof DummyStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof DummyStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof DummyStage
      */

package/src/models/DuoResponseEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `success` - Success
+ * * `waiting` - Waiting
+ * * `invalid` - Invalid
  * @export
  */
 export const DuoResponseEnum = {

package/src/models/EmailStage.ts

@@ -39,25 +39,25 @@ export interface EmailStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof EmailStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof EmailStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof EmailStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof EmailStage
      */

package/src/models/EventActions.ts

@@ -14,7 +14,33 @@
 
 
 /**
- * 
+ * * `login` - Login
+ * * `login_failed` - Login Failed
+ * * `logout` - Logout
+ * * `user_write` - User Write
+ * * `suspicious_request` - Suspicious Request
+ * * `password_set` - Password Set
+ * * `secret_view` - Secret View
+ * * `secret_rotate` - Secret Rotate
+ * * `invitation_used` - Invite Used
+ * * `authorize_application` - Authorize Application
+ * * `source_linked` - Source Linked
+ * * `impersonation_started` - Impersonation Started
+ * * `impersonation_ended` - Impersonation Ended
+ * * `flow_execution` - Flow Execution
+ * * `policy_execution` - Policy Execution
+ * * `policy_exception` - Policy Exception
+ * * `property_mapping_exception` - Property Mapping Exception
+ * * `system_task_execution` - System Task Execution
+ * * `system_task_exception` - System Task Exception
+ * * `system_exception` - System Exception
+ * * `configuration_error` - Configuration Error
+ * * `model_created` - Model Created
+ * * `model_updated` - Model Updated
+ * * `model_deleted` - Model Deleted
+ * * `email_sent` - Email Sent
+ * * `update_available` - Update Available
+ * * `custom_` - Custom Prefix
  * @export
  */
 export const EventActions = {