@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

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

@@ -40,6 +40,14 @@ export interface PatchedFlowRequest {
     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 PatchedFlowRequest
      */
@@ -64,12 +72,21 @@ export interface PatchedFlowRequest {
     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 PatchedFlowRequest
      */
     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 PatchedFlowRequest
      */

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

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

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

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

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

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

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

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

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

@@ -29,7 +29,7 @@ export interface PatchedOAuth2ProviderRequest {
      * @type {string}
      * @memberof PatchedOAuth2ProviderRequest
      */
-    authorizationFlow?: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -38,6 +38,9 @@ export interface PatchedOAuth2ProviderRequest {
     propertyMappings?: Array<string>;
     /**
      * Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
+     *
+     * * `confidential` - Confidential
+     * * `public` - Public
      * @type {ClientTypeEnum}
      * @memberof PatchedOAuth2ProviderRequest
      */
@@ -92,12 +95,21 @@ export interface PatchedOAuth2ProviderRequest {
     redirectUris?: string;
     /**
      * Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
+     *
+     * * `hashed_user_id` - Based on the Hashed User ID
+     * * `user_id` - Based on user ID
+     * * `user_username` - Based on the username
+     * * `user_email` - Based on the User's Email. This is recommended over the UPN method.
+     * * `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.
      * @type {SubModeEnum}
      * @memberof PatchedOAuth2ProviderRequest
      */
     subMode?: SubModeEnum | null;
     /**
      * Configure how the issuer field of the ID Token should be filled.
+     *
+     * * `global` - Same identifier is used for all providers
+     * * `per_provider` - Each provider has a different issuer, based on the application slug.
      * @type {IssuerModeEnum}
      * @memberof PatchedOAuth2ProviderRequest
      */

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

@@ -56,6 +56,12 @@ export interface PatchedOAuthSourceRequest {
     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 PatchedOAuthSourceRequest
      */

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

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

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

@@ -27,7 +27,7 @@ export interface PatchedProxyProviderRequest {
      * @type {string}
      * @memberof PatchedProxyProviderRequest
      */
-    authorizationFlow?: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -84,6 +84,10 @@ export interface PatchedProxyProviderRequest {
     basicAuthUserAttribute?: string;
     /**
      * Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
+     *
+     * * `proxy` - Proxy
+     * * `forward_single` - Forward Single
+     * * `forward_domain` - Forward Domain
      * @type {ProxyMode}
      * @memberof PatchedProxyProviderRequest
      */

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

@@ -29,7 +29,7 @@ export interface PatchedSAMLProviderRequest {
      * @type {string}
      * @memberof PatchedSAMLProviderRequest
      */
-    authorizationFlow?: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -104,6 +104,9 @@ export interface PatchedSAMLProviderRequest {
     verificationKp?: string | null;
     /**
      * This determines how authentik sends the response back to the Service Provider.
+     *
+     * * `redirect` - Redirect
+     * * `post` - Post
      * @type {SpBindingEnum}
      * @memberof PatchedSAMLProviderRequest
      */

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

@@ -59,6 +59,12 @@ export interface PatchedSAMLSourceRequest {
     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 PatchedSAMLSourceRequest
      */
@@ -101,6 +107,12 @@ export interface PatchedSAMLSourceRequest {
     allowIdpInitiated?: boolean;
     /**
      * NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
+     *
+     * * `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
      * @type {NameIdPolicyEnum}
      * @memberof PatchedSAMLSourceRequest
      */

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

@@ -0,0 +1,39 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.2.2
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * SCIMMapping Serializer
+ * @export
+ * @interface PatchedSCIMMappingRequest
+ */
+export interface PatchedSCIMMappingRequest {
+    /**
+     * Objects which are managed by authentik. These objects are created and updated automatically. This is flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
+     * @type {string}
+     * @memberof PatchedSCIMMappingRequest
+     */
+    managed?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchedSCIMMappingRequest
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchedSCIMMappingRequest
+     */
+    expression?: string;
+}
+export declare function PatchedSCIMMappingRequestFromJSON(json: any): PatchedSCIMMappingRequest;
+export declare function PatchedSCIMMappingRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedSCIMMappingRequest;
+export declare function PatchedSCIMMappingRequestToJSON(value?: PatchedSCIMMappingRequest | null): any;

package/dist/esm/models/PatchedSCIMMappingRequest.js

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.2.2
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+export function PatchedSCIMMappingRequestFromJSON(json) {
+    return PatchedSCIMMappingRequestFromJSONTyped(json, false);
+}
+export function PatchedSCIMMappingRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'managed': !exists(json, 'managed') ? undefined : json['managed'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'expression': !exists(json, 'expression') ? undefined : json['expression'],
+    };
+}
+export function PatchedSCIMMappingRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'managed': value.managed,
+        'name': value.name,
+        'expression': value.expression,
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.2.2
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * SCIMProvider Serializer
+ * @export
+ * @interface PatchedSCIMProviderRequest
+ */
+export interface PatchedSCIMProviderRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PatchedSCIMProviderRequest
+     */
+    name?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PatchedSCIMProviderRequest
+     */
+    propertyMappings?: Array<string>;
+    /**
+     * Property mappings used for group creation/updating.
+     * @type {Array<string>}
+     * @memberof PatchedSCIMProviderRequest
+     */
+    propertyMappingsGroup?: Array<string>;
+    /**
+     * Base URL to SCIM requests, usually ends in /v2
+     * @type {string}
+     * @memberof PatchedSCIMProviderRequest
+     */
+    url?: string;
+    /**
+     * Authentication token
+     * @type {string}
+     * @memberof PatchedSCIMProviderRequest
+     */
+    token?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchedSCIMProviderRequest
+     */
+    excludeUsersServiceAccount?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchedSCIMProviderRequest
+     */
+    filterGroup?: string | null;
+}
+export declare function PatchedSCIMProviderRequestFromJSON(json: any): PatchedSCIMProviderRequest;
+export declare function PatchedSCIMProviderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedSCIMProviderRequest;
+export declare function PatchedSCIMProviderRequestToJSON(value?: PatchedSCIMProviderRequest | null): any;

package/dist/esm/models/PatchedSCIMProviderRequest.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.2.2
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+export function PatchedSCIMProviderRequestFromJSON(json) {
+    return PatchedSCIMProviderRequestFromJSONTyped(json, false);
+}
+export function PatchedSCIMProviderRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'propertyMappings': !exists(json, 'property_mappings') ? undefined : json['property_mappings'],
+        'propertyMappingsGroup': !exists(json, 'property_mappings_group') ? undefined : json['property_mappings_group'],
+        'url': !exists(json, 'url') ? undefined : json['url'],
+        'token': !exists(json, 'token') ? undefined : json['token'],
+        'excludeUsersServiceAccount': !exists(json, 'exclude_users_service_account') ? undefined : json['exclude_users_service_account'],
+        'filterGroup': !exists(json, 'filter_group') ? undefined : json['filter_group'],
+    };
+}
+export function PatchedSCIMProviderRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'property_mappings': value.propertyMappings,
+        'property_mappings_group': value.propertyMappingsGroup,
+        'url': value.url,
+        'token': value.token,
+        'exclude_users_service_account': value.excludeUsersServiceAccount,
+        'filter_group': value.filterGroup,
+    };
+}

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

@@ -54,25 +54,25 @@ export interface PlexSource {
      */
     enrollmentFlow?: string | null;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof PlexSource
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof PlexSource
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof PlexSource
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof PlexSource
      */
@@ -85,6 +85,12 @@ export interface PlexSource {
     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 PlexSource
      */
@@ -102,7 +108,8 @@ export interface PlexSource {
      */
     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 PlexSource
      */

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

@@ -54,25 +54,25 @@ export interface PlexSourceConnectionSource {
      */
     enrollmentFlow?: string | null;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof PlexSourceConnectionSource
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof PlexSourceConnectionSource
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof PlexSourceConnectionSource
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof PlexSourceConnectionSource
      */
@@ -85,6 +85,12 @@ export interface PlexSourceConnectionSource {
     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 PlexSourceConnectionSource
      */
@@ -102,7 +108,8 @@ export interface PlexSourceConnectionSource {
      */
     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 PlexSourceConnectionSource
      */

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

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

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

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

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

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

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

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `all` - ALL, all policies must pass
+ * * `any` - ANY, any policy must pass
  * @export
  */
 export declare const PolicyEngineMode: {

package/dist/esm/models/PolicyEngineMode.js

@@ -12,7 +12,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `all` - ALL, all policies must pass
+ * * `any` - ANY, any policy must pass
  * @export
  */
 export const PolicyEngineMode = {

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

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