@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/models/DeniedActionEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeniedActionEnumToJSON = exports.DeniedActionEnumFromJSONTyped = exports.DeniedActionEnumFromJSON = exports.DeniedActionEnum = void 0;
 /**
- *
+ * * `message_continue` - Message Continue
+ * * `message` - Message
+ * * `continue` - Continue
  * @export
  */
 exports.DeniedActionEnum = {

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

@@ -15,7 +15,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeviceClassesEnumToJSON = exports.DeviceClassesEnumFromJSONTyped = exports.DeviceClassesEnumFromJSON = exports.DeviceClassesEnum = void 0;
 /**
- *
+ * * `static` - Static
+ * * `totp` - TOTP
+ * * `webauthn` - WebAuthn
+ * * `duo` - Duo
+ * * `sms` - SMS
  * @export
  */
 exports.DeviceClassesEnum = {

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

@@ -15,7 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DigestAlgorithmEnumToJSON = exports.DigestAlgorithmEnumFromJSONTyped = exports.DigestAlgorithmEnumFromJSON = exports.DigestAlgorithmEnum = void 0;
 /**
- *
+ * * `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
  */
 exports.DigestAlgorithmEnum = {

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

package/dist/models/DigitsEnum.js

@@ -15,7 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DigitsEnumToJSON = exports.DigitsEnumFromJSONTyped = exports.DigitsEnumFromJSON = exports.DigitsEnum = void 0;
 /**
- *
+ * * `6` - 6 digits, widely compatible
+ * * `8` - 8 digits, not compatible with apps like Google Authenticator
  * @export
  */
 exports.DigitsEnum = {

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

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DuoResponseEnumToJSON = exports.DuoResponseEnumFromJSONTyped = exports.DuoResponseEnumFromJSON = exports.DuoResponseEnum = void 0;
 /**
- *
+ * * `success` - Success
+ * * `waiting` - Waiting
+ * * `invalid` - Invalid
  * @export
  */
 exports.DuoResponseEnum = {

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

@@ -15,7 +15,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventActionsToJSON = exports.EventActionsFromJSONTyped = exports.EventActionsFromJSON = exports.EventActions = void 0;
 /**
- *
+ * * `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
  */
 exports.EventActions = {

package/dist/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/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/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/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
      */