@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/src/models/PatchedSCIMProviderRequest.ts

@@ -0,0 +1,104 @@
+/* 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, mapValues } from '../runtime';
+/**
+ * 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 function PatchedSCIMProviderRequestFromJSON(json: any): PatchedSCIMProviderRequest {
+    return PatchedSCIMProviderRequestFromJSONTyped(json, false);
+}
+
+export function PatchedSCIMProviderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedSCIMProviderRequest {
+    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?: PatchedSCIMProviderRequest | null): any {
+    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/src/models/PlexSource.ts

@@ -69,25 +69,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
      */
@@ -100,6 +100,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
      */
@@ -117,7 +123,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/src/models/PlexSourceConnectionSource.ts

@@ -75,25 +75,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
      */
@@ -106,6 +106,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
      */
@@ -123,7 +129,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/src/models/PlexSourceRequest.ts

@@ -70,6 +70,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/src/models/Policy.ts

@@ -38,31 +38,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/src/models/PolicyBindingPolicyObj.ts

@@ -45,31 +45,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/src/models/PolicyEngineMode.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `all` - ALL, all policies must pass
+ * * `any` - ANY, any policy must pass
  * @export
  */
 export const PolicyEngineMode = {

package/src/models/PromptStage.ts

@@ -39,25 +39,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
      */

package/src/models/PromptTypeEnum.ts

@@ -14,7 +14,20 @@
 
 
 /**
- * 
+ * * `text` - Text: Simple Text input
+ * * `text_read_only` - Text (read-only): Simple Text input, but cannot be edited.
+ * * `username` - Username: Same as Text input, but checks for and prevents duplicate usernames.
+ * * `email` - Email: Text field with Email type.
+ * * `password` - Password: Masked input, password is validated against sources. Policies still have to be applied to this Stage. If two of these are used in the same stage, they are ensured to be identical.
+ * * `number` - Number
+ * * `checkbox` - Checkbox
+ * * `date` - Date
+ * * `date-time` - Date Time
+ * * `file` - File: File upload for arbitrary files. File content will be available in flow context as data-URI
+ * * `separator` - Separator: Static Separator Line
+ * * `hidden` - Hidden: Hidden field, can be used to insert data into form.
+ * * `static` - Static: Static value, displayed as-is.
+ * * `ak-locale` - authentik: Selection of locales authentik supports
  * @export
  */
 export const PromptTypeEnum = {

package/src/models/PropertyMapping.ts

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

package/src/models/Provider.ts

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

package/src/models/ProviderEnum.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `twilio` - Twilio
+ * * `generic` - Generic
  * @export
  */
 export const ProviderEnum = {

package/src/models/ProviderTypeEnum.ts

@@ -14,7 +14,18 @@
 
 
 /**
- * 
+ * * `apple` - Apple
+ * * `azuread` - Azure AD
+ * * `discord` - Discord
+ * * `facebook` - Facebook
+ * * `github` - GitHub
+ * * `google` - Google
+ * * `openidconnect` - OpenID Connect
+ * * `okta` - Okta
+ * * `reddit` - reddit
+ * * `twitter` - Twitter
+ * * `mailcow` - Mailcow
+ * * `twitch` - Twitch
  * @export
  */
 export const ProviderTypeEnum = {

package/src/models/ProxyMode.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `proxy` - Proxy
+ * * `forward_single` - Forward Single
+ * * `forward_domain` - Forward Domain
  * @export
  */
 export const ProxyMode = {

package/src/models/ProxyOutpostConfig.ts

@@ -118,6 +118,10 @@ export interface ProxyOutpostConfig {
     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 ProxyOutpostConfig
      */
@@ -129,7 +133,7 @@ export interface ProxyOutpostConfig {
      */
     cookieDomain?: string;
     /**
-     * 
+     * Get token validity as second count
      * @type {number}
      * @memberof ProxyOutpostConfig
      */
@@ -141,7 +145,8 @@ export interface ProxyOutpostConfig {
      */
     interceptHeaderAuth?: boolean;
     /**
-     * 
+     * Get all the scope names the outpost should request,
+     * including custom-defined ones
      * @type {Array<string>}
      * @memberof ProxyOutpostConfig
      */

package/src/models/ProxyProvider.ts

@@ -43,7 +43,7 @@ export interface ProxyProvider {
      * @type {string}
      * @memberof ProxyProvider
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -51,7 +51,7 @@ export interface ProxyProvider {
      */
     propertyMappings?: Array<string>;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof ProxyProvider
      */
@@ -69,19 +69,19 @@ export interface ProxyProvider {
      */
     readonly assignedApplicationName: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof ProxyProvider
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof ProxyProvider
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof ProxyProvider
      */
@@ -142,6 +142,10 @@ export interface ProxyProvider {
     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 ProxyProvider
      */
@@ -202,7 +206,7 @@ export function ProxyProviderFromJSONTyped(json: any, ignoreDiscriminator: boole
         
         '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/src/models/ProxyProviderRequest.ts

@@ -37,7 +37,7 @@ export interface ProxyProviderRequest {
      * @type {string}
      * @memberof ProxyProviderRequest
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -94,6 +94,10 @@ export interface ProxyProviderRequest {
     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 ProxyProviderRequest
      */
@@ -141,7 +145,7 @@ export function ProxyProviderRequestFromJSONTyped(json: any, 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'],
         'internalHost': !exists(json, 'internal_host') ? undefined : json['internal_host'],
         'externalHost': json['external_host'],

package/src/models/ReputationPolicy.ts

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

package/src/models/ResidentKeyRequirementEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `discouraged` - Discouraged
+ * * `preferred` - Preferred
+ * * `required` - Required
  * @export
  */
 export const ResidentKeyRequirementEnum = {

package/src/models/SAMLPropertyMapping.ts

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