@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

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

@@ -51,12 +51,21 @@ export interface FlowSet {
     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 FlowSet
      */
     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 FlowSet
      */
@@ -74,7 +83,7 @@ export interface FlowSet {
      */
     compatibilityMode?: boolean;
     /**
-     *
+     * Get export URL for flow
      * @type {string}
      * @memberof FlowSet
      */
@@ -87,6 +96,10 @@ export interface FlowSet {
     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 FlowSet
      */

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

@@ -39,6 +39,14 @@ export interface FlowSetRequest {
     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 FlowSetRequest
      */
@@ -63,6 +71,10 @@ export interface FlowSetRequest {
     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 FlowSetRequest
      */

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

@@ -74,6 +74,10 @@ export interface FlowStageBinding {
     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 FlowStageBinding
      */

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

@@ -55,6 +55,10 @@ export interface FlowStageBindingRequest {
     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 FlowStageBindingRequest
      */

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

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

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

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

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

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `verification` - Intent Verification
+ * * `api` - Intent Api
+ * * `recovery` - Intent Recovery
+ * * `app_password` - Intent App Password
  * @export
  */
 export declare const IntentEnum: {

package/dist/esm/models/IntentEnum.js

@@ -12,7 +12,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `verification` - Intent Verification
+ * * `api` - Intent Api
+ * * `recovery` - Intent Recovery
+ * * `app_password` - Intent App Password
  * @export
  */
 export const IntentEnum = {

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

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `retry` - Retry
+ * * `restart` - Restart
+ * * `restart_with_context` - Restart With Context
  * @export
  */
 export declare const InvalidResponseActionEnum: {

package/dist/esm/models/InvalidResponseActionEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `retry` - Retry
+ * * `restart` - Restart
+ * * `restart_with_context` - Restart With Context
  * @export
  */
 export const InvalidResponseActionEnum = {

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

@@ -52,12 +52,21 @@ export interface InvitationFlowObj {
     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 InvitationFlowObj
      */
     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 InvitationFlowObj
      */
@@ -75,7 +84,7 @@ export interface InvitationFlowObj {
      */
     readonly policies: Array<string>;
     /**
-     *
+     * Get count of cached flows
      * @type {number}
      * @memberof InvitationFlowObj
      */
@@ -93,7 +102,7 @@ export interface InvitationFlowObj {
      */
     compatibilityMode?: boolean;
     /**
-     *
+     * Get export URL for flow
      * @type {string}
      * @memberof InvitationFlowObj
      */
@@ -106,12 +115,21 @@ export interface InvitationFlowObj {
     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 InvitationFlowObj
      */
     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 InvitationFlowObj
      */

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

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

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

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `global` - Same identifier is used for all providers
+ * * `per_provider` - Each provider has a different issuer, based on the application slug.
  * @export
  */
 export declare const IssuerModeEnum: {

package/dist/esm/models/IssuerModeEnum.js

@@ -12,7 +12,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `global` - Same identifier is used for all providers
+ * * `per_provider` - Each provider has a different issuer, based on the application slug.
  * @export
  */
 export const IssuerModeEnum = {

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

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

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

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `direct` - Direct
+ * * `cached` - Cached
  * @export
  */
 export declare const LDAPAPIAccessMode: {

package/dist/esm/models/LDAPAPIAccessMode.js

@@ -12,7 +12,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `direct` - Direct
+ * * `cached` - Cached
  * @export
  */
 export const LDAPAPIAccessMode = {

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

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

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

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

package/dist/esm/models/LDAPProvider.js

@@ -23,7 +23,7 @@ export function LDAPProviderFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'pk': json['pk'],
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !exists(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !exists(json, 'property_mappings') ? undefined : json['property_mappings'],
         'component': json['component'],
         'assignedApplicationSlug': json['assigned_application_slug'],

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

@@ -27,7 +27,7 @@ export interface LDAPProviderRequest {
      * @type {string}
      * @memberof LDAPProviderRequest
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}

package/dist/esm/models/LDAPProviderRequest.js

@@ -22,7 +22,7 @@ export function LDAPProviderRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !exists(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !exists(json, 'property_mappings') ? undefined : json['property_mappings'],
         'baseDn': !exists(json, 'base_dn') ? undefined : json['base_dn'],
         'searchGroup': !exists(json, 'search_group') ? undefined : json['search_group'],

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

@@ -54,25 +54,25 @@ export interface LDAPSource {
      */
     enrollmentFlow?: string | null;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof LDAPSource
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof LDAPSource
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof LDAPSource
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof LDAPSource
      */
@@ -85,6 +85,12 @@ export interface LDAPSource {
     policyEngineMode?: PolicyEngineMode;
     /**
      * How the source determines if an existing user should be authenticated or a new user enrolled.
+     *
+     * * `identifier` - Use the source-specific identifier
+     * * `email_link` - Link to a user with identical email address. Can have security implications when a source doesn't validate email addresses.
+     * * `email_deny` - Use the user's email address, but deny enrollment when the email address already exists.
+     * * `username_link` - Link to a user with identical username. Can have security implications when a username is used with another source.
+     * * `username_deny` - Use the user's username, but deny enrollment when the username already exists.
      * @type {UserMatchingModeEnum}
      * @memberof LDAPSource
      */
@@ -102,7 +108,8 @@ export interface LDAPSource {
      */
     userPathTemplate?: string;
     /**
-     *
+     * Get the URL to the Icon. If the name is /static or
+     * starts with http it is returned as-is
      * @type {string}
      * @memberof LDAPSource
      */

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

@@ -55,6 +55,12 @@ export interface LDAPSourceRequest {
     policyEngineMode?: PolicyEngineMode;
     /**
      * How the source determines if an existing user should be authenticated or a new user enrolled.
+     *
+     * * `identifier` - Use the source-specific identifier
+     * * `email_link` - Link to a user with identical email address. Can have security implications when a source doesn't validate email addresses.
+     * * `email_deny` - Use the user's email address, but deny enrollment when the email address already exists.
+     * * `username_link` - Link to a user with identical username. Can have security implications when a username is used with another source.
+     * * `username_deny` - Use the user's username, but deny enrollment when the username already exists.
      * @type {UserMatchingModeEnum}
      * @memberof LDAPSourceRequest
      */

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

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `stacked` - STACKED
+ * * `content_left` - CONTENT_LEFT
+ * * `content_right` - CONTENT_RIGHT
+ * * `sidebar_left` - SIDEBAR_LEFT
+ * * `sidebar_right` - SIDEBAR_RIGHT
  * @export
  */
 export declare const LayoutEnum: {

package/dist/esm/models/LayoutEnum.js

@@ -12,7 +12,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `stacked` - STACKED
+ * * `content_left` - CONTENT_LEFT
+ * * `content_right` - CONTENT_RIGHT
+ * * `sidebar_left` - SIDEBAR_LEFT
+ * * `sidebar_right` - SIDEBAR_RIGHT
  * @export
  */
 export const LayoutEnum = {

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

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` - Email
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` - Persistent
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:X509SubjectName` - X509
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:WindowsDomainQualifiedName` - Windows
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` - Transient
  * @export
  */
 export declare const NameIdPolicyEnum: {

package/dist/esm/models/NameIdPolicyEnum.js

@@ -12,7 +12,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` - Email
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` - Persistent
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:X509SubjectName` - X509
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:WindowsDomainQualifiedName` - Windows
+ * * `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` - Transient
  * @export
  */
 export const NameIdPolicyEnum = {

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

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `skip` - Skip
+ * * `deny` - Deny
+ * * `configure` - Configure
  * @export
  */
 export declare const NotConfiguredActionEnum: {

package/dist/esm/models/NotConfiguredActionEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `skip` - Skip
+ * * `deny` - Deny
+ * * `configure` - Configure
  * @export
  */
 export const NotConfiguredActionEnum = {

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

@@ -37,6 +37,10 @@ export interface NotificationRule {
     transports?: Array<string>;
     /**
      * Controls which severity level the created notifications will have.
+     *
+     * * `notice` - Notice
+     * * `warning` - Warning
+     * * `alert` - Alert
      * @type {SeverityEnum}
      * @memberof NotificationRule
      */

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

@@ -30,6 +30,10 @@ export interface NotificationRuleRequest {
     transports?: Array<string>;
     /**
      * Controls which severity level the created notifications will have.
+     *
+     * * `notice` - Notice
+     * * `warning` - Warning
+     * * `alert` - Alert
      * @type {SeverityEnum}
      * @memberof NotificationRuleRequest
      */

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

@@ -35,7 +35,7 @@ export interface NotificationTransport {
      */
     mode?: NotificationTransportModeEnum;
     /**
-     *
+     * Return selected mode with a UI Label
      * @type {string}
      * @memberof NotificationTransport
      */

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

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `local` - authentik inbuilt notifications
+ * * `webhook` - Generic Webhook
+ * * `webhook_slack` - Slack Webhook (Slack/Discord)
+ * * `email` - Email
  * @export
  */
 export declare const NotificationTransportModeEnum: {