@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/models/Application.d.ts

@@ -48,7 +48,7 @@ export interface Application {
      */
     providerObj: ApplicationProviderObj;
     /**
-     *
+     * Allow formatting of launch URL
      * @type {string}
      * @memberof Application
      */
@@ -66,7 +66,8 @@ export interface Application {
      */
     metaLaunchUrl?: string;
     /**
-     *
+     * Get the URL to the App Icon image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof Application
      */

package/dist/models/ApplicationProviderObj.d.ts

@@ -40,7 +40,7 @@ export interface ApplicationProviderObj {
      */
     propertyMappings?: Array<string>;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof ApplicationProviderObj
      */
@@ -58,19 +58,19 @@ export interface ApplicationProviderObj {
      */
     readonly assignedApplicationName: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof ApplicationProviderObj
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof ApplicationProviderObj
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof ApplicationProviderObj
      */

package/dist/models/AuthTypeEnum.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `basic` - Basic
+ * * `bearer` - Bearer
  * @export
  */
 export declare const AuthTypeEnum: {

package/dist/models/AuthTypeEnum.js

@@ -15,7 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthTypeEnumToJSON = exports.AuthTypeEnumFromJSONTyped = exports.AuthTypeEnumFromJSON = exports.AuthTypeEnum = void 0;
 /**
- *
+ * * `basic` - Basic
+ * * `bearer` - Bearer
  * @export
  */
 exports.AuthTypeEnum = {

package/dist/models/AuthenticateWebAuthnStage.d.ts

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

package/dist/models/AuthenticatedSession.d.ts

@@ -24,7 +24,7 @@ export interface AuthenticatedSession {
      */
     uuid?: string;
     /**
-     *
+     * Check if session is currently active session
      * @type {boolean}
      * @memberof AuthenticatedSession
      */

package/dist/models/AuthenticatedSessionGeoIp.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * GeoIP Details
+ * Get parsed user agent
  * @export
  * @interface AuthenticatedSessionGeoIp
  */

package/dist/models/AuthenticatedSessionUserAgent.d.ts

@@ -13,7 +13,7 @@ import { AuthenticatedSessionUserAgentDevice } from './AuthenticatedSessionUserA
 import { AuthenticatedSessionUserAgentOs } from './AuthenticatedSessionUserAgentOs';
 import { AuthenticatedSessionUserAgentUserAgent } from './AuthenticatedSessionUserAgentUserAgent';
 /**
- * User agent details
+ * Get parsed user agent
  * @export
  * @interface AuthenticatedSessionUserAgent
  */

package/dist/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/models/AuthenticationEnum.js

@@ -15,7 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthenticationEnumToJSON = exports.AuthenticationEnumFromJSONTyped = exports.AuthenticationEnumFromJSON = exports.AuthenticationEnum = void 0;
 /**
- *
+ * * `none` - None
+ * * `require_authenticated` - Require Authenticated
+ * * `require_unauthenticated` - Require Unauthenticated
+ * * `require_superuser` - Require Superuser
  * @export
  */
 exports.AuthenticationEnum = {

package/dist/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/models/AuthenticatorAttachmentEnum.js

@@ -15,7 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthenticatorAttachmentEnumToJSON = exports.AuthenticatorAttachmentEnumFromJSONTyped = exports.AuthenticatorAttachmentEnumFromJSON = exports.AuthenticatorAttachmentEnum = void 0;
 /**
- *
+ * * `platform` - Platform
+ * * `cross-platform` - Cross Platform
  * @export
  */
 exports.AuthenticatorAttachmentEnum = {

package/dist/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/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/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/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/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/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/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/models/BackendsEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BackendsEnumToJSON = exports.BackendsEnumFromJSONTyped = exports.BackendsEnumFromJSON = exports.BackendsEnum = void 0;
 /**
- *
+ * * `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
  */
 exports.BackendsEnum = {

package/dist/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/models/BindingTypeEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BindingTypeEnumToJSON = exports.BindingTypeEnumFromJSONTyped = exports.BindingTypeEnumFromJSON = exports.BindingTypeEnum = void 0;
 /**
- *
+ * * `REDIRECT` - Redirect Binding
+ * * `POST` - POST Binding
+ * * `POST_AUTO` - POST Binding with auto-confirmation
  * @export
  */
 exports.BindingTypeEnum = {

package/dist/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/models/BlueprintInstanceStatusEnum.js

@@ -15,7 +15,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BlueprintInstanceStatusEnumToJSON = exports.BlueprintInstanceStatusEnumFromJSONTyped = exports.BlueprintInstanceStatusEnumFromJSON = exports.BlueprintInstanceStatusEnum = void 0;
 /**
- *
+ * * `successful` - Successful
+ * * `warning` - Warning
+ * * `error` - Error
+ * * `orphaned` - Orphaned
+ * * `unknown` - Unknown
  * @export
  */
 exports.BlueprintInstanceStatusEnum = {

package/dist/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/models/CapabilitiesEnum.js

@@ -15,7 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CapabilitiesEnumToJSON = exports.CapabilitiesEnumFromJSONTyped = exports.CapabilitiesEnumFromJSON = exports.CapabilitiesEnum = void 0;
 /**
- *
+ * * `can_save_media` - Can Save Media
+ * * `can_geo_ip` - Can Geo Ip
+ * * `can_impersonate` - Can Impersonate
+ * * `can_debug` - Can Debug
  * @export
  */
 exports.CapabilitiesEnum = {

package/dist/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/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/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/models/ChallengeChoices.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChallengeChoicesToJSON = exports.ChallengeChoicesFromJSONTyped = exports.ChallengeChoicesFromJSON = exports.ChallengeChoices = void 0;
 /**
- *
+ * * `native` - NATIVE
+ * * `shell` - SHELL
+ * * `redirect` - REDIRECT
  * @export
  */
 exports.ChallengeChoices = {

package/dist/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/models/ClientTypeEnum.js

@@ -15,7 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientTypeEnumToJSON = exports.ClientTypeEnumFromJSONTyped = exports.ClientTypeEnumFromJSON = exports.ClientTypeEnum = void 0;
 /**
- *
+ * * `confidential` - Confidential
+ * * `public` - Public
  * @export
  */
 exports.ClientTypeEnum = {

package/dist/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/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/models/ConsentStageModeEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConsentStageModeEnumToJSON = exports.ConsentStageModeEnumFromJSONTyped = exports.ConsentStageModeEnumFromJSON = exports.ConsentStageModeEnum = void 0;
 /**
- *
+ * * `always_require` - Always Require
+ * * `permanent` - Permanent
+ * * `expiring` - Expiring
  * @export
  */
 exports.ConsentStageModeEnum = {

package/dist/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: {