@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/esm/models/AuthenticationEnum.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `none` - None
+ * * `require_authenticated` - Require Authenticated
+ * * `require_unauthenticated` - Require Unauthenticated
+ * * `require_superuser` - Require Superuser
  * @export
  */
 export declare const AuthenticationEnum: {

package/dist/esm/models/AuthenticationEnum.js

@@ -12,7 +12,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `none` - None
+ * * `require_authenticated` - Require Authenticated
+ * * `require_unauthenticated` - Require Unauthenticated
+ * * `require_superuser` - Require Superuser
  * @export
  */
 export const AuthenticationEnum = {

package/dist/esm/models/AuthenticatorAttachmentEnum.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `platform` - Platform
+ * * `cross-platform` - Cross Platform
  * @export
  */
 export declare const AuthenticatorAttachmentEnum: {

package/dist/esm/models/AuthenticatorAttachmentEnum.js

@@ -12,7 +12,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `platform` - Platform
+ * * `cross-platform` - Cross Platform
  * @export
  */
 export const AuthenticatorAttachmentEnum = {

package/dist/esm/models/AuthenticatorDuoStage.d.ts

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

package/dist/esm/models/AuthenticatorSMSStage.d.ts

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

package/dist/esm/models/AuthenticatorStaticStage.d.ts

@@ -29,25 +29,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/dist/esm/models/AuthenticatorTOTPStage.d.ts

@@ -30,25 +30,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/dist/esm/models/AuthenticatorValidateStage.d.ts

@@ -32,25 +32,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
      */
@@ -87,6 +87,10 @@ export interface AuthenticatorValidateStage {
     lastAuthThreshold?: string;
     /**
      * Enforce user verification for WebAuthn devices.
+     *
+     * * `required` - Required
+     * * `preferred` - Preferred
+     * * `discouraged` - Discouraged
      * @type {UserVerificationEnum}
      * @memberof AuthenticatorValidateStage
      */

package/dist/esm/models/AuthenticatorValidateStageRequest.d.ts

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

package/dist/esm/models/BackendsEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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 declare const BackendsEnum: {

package/dist/esm/models/BackendsEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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/dist/esm/models/BindingTypeEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `REDIRECT` - Redirect Binding
+ * * `POST` - POST Binding
+ * * `POST_AUTO` - POST Binding with auto-confirmation
  * @export
  */
 export declare const BindingTypeEnum: {

package/dist/esm/models/BindingTypeEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `REDIRECT` - Redirect Binding
+ * * `POST` - POST Binding
+ * * `POST_AUTO` - POST Binding with auto-confirmation
  * @export
  */
 export const BindingTypeEnum = {

package/dist/esm/models/BlueprintInstanceStatusEnum.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `successful` - Successful
+ * * `warning` - Warning
+ * * `error` - Error
+ * * `orphaned` - Orphaned
+ * * `unknown` - Unknown
  * @export
  */
 export declare const BlueprintInstanceStatusEnum: {

package/dist/esm/models/BlueprintInstanceStatusEnum.js

@@ -12,7 +12,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `successful` - Successful
+ * * `warning` - Warning
+ * * `error` - Error
+ * * `orphaned` - Orphaned
+ * * `unknown` - Unknown
  * @export
  */
 export const BlueprintInstanceStatusEnum = {

package/dist/esm/models/CapabilitiesEnum.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `can_save_media` - Can Save Media
+ * * `can_geo_ip` - Can Geo Ip
+ * * `can_impersonate` - Can Impersonate
+ * * `can_debug` - Can Debug
  * @export
  */
 export declare const CapabilitiesEnum: {

package/dist/esm/models/CapabilitiesEnum.js

@@ -12,7 +12,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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/dist/esm/models/CaptchaStage.d.ts

@@ -29,25 +29,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/dist/esm/models/CertificateKeyPair.d.ts

@@ -28,49 +28,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/dist/esm/models/ChallengeChoices.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `native` - NATIVE
+ * * `shell` - SHELL
+ * * `redirect` - REDIRECT
  * @export
  */
 export declare const ChallengeChoices: {

package/dist/esm/models/ChallengeChoices.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `native` - NATIVE
+ * * `shell` - SHELL
+ * * `redirect` - REDIRECT
  * @export
  */
 export const ChallengeChoices = {

package/dist/esm/models/ClientTypeEnum.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `confidential` - Confidential
+ * * `public` - Public
  * @export
  */
 export declare const ClientTypeEnum: {

package/dist/esm/models/ClientTypeEnum.js

@@ -12,7 +12,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `confidential` - Confidential
+ * * `public` - Public
  * @export
  */
 export const ClientTypeEnum = {

package/dist/esm/models/ConsentStage.d.ts

@@ -30,25 +30,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/dist/esm/models/ConsentStageModeEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `always_require` - Always Require
+ * * `permanent` - Permanent
+ * * `expiring` - Expiring
  * @export
  */
 export declare const ConsentStageModeEnum: {

package/dist/esm/models/ConsentStageModeEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `always_require` - Always Require
+ * * `permanent` - Permanent
+ * * `expiring` - Expiring
  * @export
  */
 export const ConsentStageModeEnum = {

package/dist/esm/models/DeniedActionEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `message_continue` - Message Continue
+ * * `message` - Message
+ * * `continue` - Continue
  * @export
  */
 export declare const DeniedActionEnum: {

package/dist/esm/models/DeniedActionEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `message_continue` - Message Continue
+ * * `message` - Message
+ * * `continue` - Continue
  * @export
  */
 export const DeniedActionEnum = {

package/dist/esm/models/DenyStage.d.ts

@@ -29,25 +29,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/dist/esm/models/Device.d.ts

@@ -16,19 +16,19 @@
  */
 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
      */
@@ -46,7 +46,7 @@ export interface Device {
      */
     name: string;
     /**
-     *
+     * Get type of device
      * @type {string}
      * @memberof Device
      */

package/dist/esm/models/DeviceClassesEnum.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `static` - Static
+ * * `totp` - TOTP
+ * * `webauthn` - WebAuthn
+ * * `duo` - Duo
+ * * `sms` - SMS
  * @export
  */
 export declare const DeviceClassesEnum: {

package/dist/esm/models/DeviceClassesEnum.js

@@ -12,7 +12,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `static` - Static
+ * * `totp` - TOTP
+ * * `webauthn` - WebAuthn
+ * * `duo` - Duo
+ * * `sms` - SMS
  * @export
  */
 export const DeviceClassesEnum = {

package/dist/esm/models/DigestAlgorithmEnum.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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 declare const DigestAlgorithmEnum: {

package/dist/esm/models/DigestAlgorithmEnum.js

@@ -12,7 +12,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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/dist/esm/models/DigitsEnum.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `6` - 6 digits, widely compatible
+ * * `8` - 8 digits, not compatible with apps like Google Authenticator
  * @export
  */
 export declare const DigitsEnum: {