@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/esm/models/DigitsEnum.js

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

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

@@ -40,19 +40,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/dist/esm/models/DummyPolicy.d.ts

@@ -34,31 +34,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/dist/esm/models/DummyStage.d.ts

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

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `success` - Success
+ * * `waiting` - Waiting
+ * * `invalid` - Invalid
  * @export
  */
 export declare const DuoResponseEnum: {

package/dist/esm/models/DuoResponseEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `success` - Success
+ * * `waiting` - Waiting
+ * * `invalid` - Invalid
  * @export
  */
 export const DuoResponseEnum = {

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

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

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

package/dist/esm/models/EventActions.js

@@ -12,7 +12,33 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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 = {

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

@@ -36,37 +36,65 @@ export interface EventMatcherPolicy {
      */
     executionLogging?: boolean;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly metaModelName: string;
     /**
-     *
+     * Return objects policy is bound to
      * @type {number}
      * @memberof EventMatcherPolicy
      */
     readonly boundTo: number;
     /**
      * Match created events with this action type. When left empty, all action types will be matched.
+     *
+     * * `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
      * @type {EventActions}
      * @memberof EventMatcherPolicy
      */
@@ -79,6 +107,53 @@ export interface EventMatcherPolicy {
     clientIp?: string;
     /**
      * Match events created by selected application. When left empty, all applications are matched.
+     *
+     * * `authentik.admin` - authentik Admin
+     * * `authentik.api` - authentik API
+     * * `authentik.crypto` - authentik Crypto
+     * * `authentik.events` - authentik Events
+     * * `authentik.flows` - authentik Flows
+     * * `authentik.lib` - authentik lib
+     * * `authentik.outposts` - authentik Outpost
+     * * `authentik.policies.dummy` - authentik Policies.Dummy
+     * * `authentik.policies.event_matcher` - authentik Policies.Event Matcher
+     * * `authentik.policies.expiry` - authentik Policies.Expiry
+     * * `authentik.policies.expression` - authentik Policies.Expression
+     * * `authentik.policies.password` - authentik Policies.Password
+     * * `authentik.policies.reputation` - authentik Policies.Reputation
+     * * `authentik.policies` - authentik Policies
+     * * `authentik.providers.ldap` - authentik Providers.LDAP
+     * * `authentik.providers.oauth2` - authentik Providers.OAuth2
+     * * `authentik.providers.proxy` - authentik Providers.Proxy
+     * * `authentik.providers.saml` - authentik Providers.SAML
+     * * `authentik.providers.scim` - authentik Providers.SCIM
+     * * `authentik.recovery` - authentik Recovery
+     * * `authentik.sources.ldap` - authentik Sources.LDAP
+     * * `authentik.sources.oauth` - authentik Sources.OAuth
+     * * `authentik.sources.plex` - authentik Sources.Plex
+     * * `authentik.sources.saml` - authentik Sources.SAML
+     * * `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo
+     * * `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS
+     * * `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static
+     * * `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP
+     * * `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate
+     * * `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn
+     * * `authentik.stages.captcha` - authentik Stages.Captcha
+     * * `authentik.stages.consent` - authentik Stages.Consent
+     * * `authentik.stages.deny` - authentik Stages.Deny
+     * * `authentik.stages.dummy` - authentik Stages.Dummy
+     * * `authentik.stages.email` - authentik Stages.Email
+     * * `authentik.stages.identification` - authentik Stages.Identification
+     * * `authentik.stages.invitation` - authentik Stages.User Invitation
+     * * `authentik.stages.password` - authentik Stages.Password
+     * * `authentik.stages.prompt` - authentik Stages.Prompt
+     * * `authentik.stages.user_delete` - authentik Stages.User Delete
+     * * `authentik.stages.user_login` - authentik Stages.User Login
+     * * `authentik.stages.user_logout` - authentik Stages.User Logout
+     * * `authentik.stages.user_write` - authentik Stages.User Write
+     * * `authentik.tenants` - authentik Tenants
+     * * `authentik.blueprints` - authentik Blueprints
+     * * `authentik.core` - authentik Core
      * @type {AppEnum}
      * @memberof EventMatcherPolicy
      */

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

@@ -31,6 +31,34 @@ export interface EventMatcherPolicyRequest {
     executionLogging?: boolean;
     /**
      * Match created events with this action type. When left empty, all action types will be matched.
+     *
+     * * `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
      * @type {EventActions}
      * @memberof EventMatcherPolicyRequest
      */
@@ -43,6 +71,53 @@ export interface EventMatcherPolicyRequest {
     clientIp?: string;
     /**
      * Match events created by selected application. When left empty, all applications are matched.
+     *
+     * * `authentik.admin` - authentik Admin
+     * * `authentik.api` - authentik API
+     * * `authentik.crypto` - authentik Crypto
+     * * `authentik.events` - authentik Events
+     * * `authentik.flows` - authentik Flows
+     * * `authentik.lib` - authentik lib
+     * * `authentik.outposts` - authentik Outpost
+     * * `authentik.policies.dummy` - authentik Policies.Dummy
+     * * `authentik.policies.event_matcher` - authentik Policies.Event Matcher
+     * * `authentik.policies.expiry` - authentik Policies.Expiry
+     * * `authentik.policies.expression` - authentik Policies.Expression
+     * * `authentik.policies.password` - authentik Policies.Password
+     * * `authentik.policies.reputation` - authentik Policies.Reputation
+     * * `authentik.policies` - authentik Policies
+     * * `authentik.providers.ldap` - authentik Providers.LDAP
+     * * `authentik.providers.oauth2` - authentik Providers.OAuth2
+     * * `authentik.providers.proxy` - authentik Providers.Proxy
+     * * `authentik.providers.saml` - authentik Providers.SAML
+     * * `authentik.providers.scim` - authentik Providers.SCIM
+     * * `authentik.recovery` - authentik Recovery
+     * * `authentik.sources.ldap` - authentik Sources.LDAP
+     * * `authentik.sources.oauth` - authentik Sources.OAuth
+     * * `authentik.sources.plex` - authentik Sources.Plex
+     * * `authentik.sources.saml` - authentik Sources.SAML
+     * * `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo
+     * * `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS
+     * * `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static
+     * * `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP
+     * * `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate
+     * * `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn
+     * * `authentik.stages.captcha` - authentik Stages.Captcha
+     * * `authentik.stages.consent` - authentik Stages.Consent
+     * * `authentik.stages.deny` - authentik Stages.Deny
+     * * `authentik.stages.dummy` - authentik Stages.Dummy
+     * * `authentik.stages.email` - authentik Stages.Email
+     * * `authentik.stages.identification` - authentik Stages.Identification
+     * * `authentik.stages.invitation` - authentik Stages.User Invitation
+     * * `authentik.stages.password` - authentik Stages.Password
+     * * `authentik.stages.prompt` - authentik Stages.Prompt
+     * * `authentik.stages.user_delete` - authentik Stages.User Delete
+     * * `authentik.stages.user_login` - authentik Stages.User Login
+     * * `authentik.stages.user_logout` - authentik Stages.User Logout
+     * * `authentik.stages.user_write` - authentik Stages.User Write
+     * * `authentik.tenants` - authentik Tenants
+     * * `authentik.blueprints` - authentik Blueprints
+     * * `authentik.core` - authentik Core
      * @type {AppEnum}
      * @memberof EventMatcherPolicyRequest
      */

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

@@ -36,7 +36,7 @@ export interface ExpiringBaseGrantModel {
      */
     user: User;
     /**
-     *
+     * Check if token is expired yet.
      * @type {boolean}
      * @memberof ExpiringBaseGrantModel
      */

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

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

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

@@ -52,12 +52,21 @@ export interface Flow {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     *
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof Flow
      */
     designation: FlowDesignationEnum | null;
     /**
-     *
+     * Get the URL to the background image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof Flow
      */
@@ -75,7 +84,7 @@ export interface Flow {
      */
     readonly policies: Array<string>;
     /**
-     *
+     * Get count of cached flows
      * @type {number}
      * @memberof Flow
      */
@@ -93,7 +102,7 @@ export interface Flow {
      */
     compatibilityMode?: boolean;
     /**
-     *
+     * Get export URL for flow
      * @type {string}
      * @memberof Flow
      */
@@ -106,12 +115,21 @@ export interface Flow {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     *
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof Flow
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     *
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof Flow
      */

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

@@ -10,7 +10,13 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `authentication` - Authentication
+ * * `authorization` - Authorization
+ * * `invalidation` - Invalidation
+ * * `enrollment` - Enrollment
+ * * `unenrollment` - Unrenollment
+ * * `recovery` - Recovery
+ * * `stage_configuration` - Stage Configuration
  * @export
  */
 export declare const FlowDesignationEnum: {

package/dist/esm/models/FlowDesignationEnum.js

@@ -12,7 +12,13 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `authentication` - Authentication
+ * * `authorization` - Authorization
+ * * `invalidation` - Invalidation
+ * * `enrollment` - Enrollment
+ * * `unenrollment` - Unrenollment
+ * * `recovery` - Recovery
+ * * `stage_configuration` - Stage Configuration
  * @export
  */
 export const FlowDesignationEnum = {

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

@@ -29,7 +29,7 @@ export interface FlowInspectorPlan {
      */
     nextPlannedStage: FlowInspectorPlanCurrentStage;
     /**
-     *
+     * Get the plan's context, sanitized
      * @type {{ [key: string]: any; }}
      * @memberof FlowInspectorPlan
      */
@@ -37,7 +37,7 @@ export interface FlowInspectorPlan {
         [key: string]: any;
     };
     /**
-     *
+     * Get a unique session ID
      * @type {string}
      * @memberof FlowInspectorPlan
      */

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

@@ -74,6 +74,10 @@ export interface FlowInspectorPlanCurrentStage {
     policyEngineMode?: PolicyEngineMode;
     /**
      * Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
+     *
+     * * `retry` - Retry
+     * * `restart` - Restart
+     * * `restart_with_context` - Restart With Context
      * @type {InvalidResponseActionEnum}
      * @memberof FlowInspectorPlanCurrentStage
      */

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

@@ -40,6 +40,14 @@ export interface FlowRequest {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     *
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof FlowRequest
      */
@@ -64,12 +72,21 @@ export interface FlowRequest {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     *
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof FlowRequest
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     *
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof FlowRequest
      */