@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

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

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

package/dist/esm/models/PromptTypeEnum.js

@@ -12,7 +12,20 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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/dist/esm/models/PropertyMapping.d.ts

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

@@ -40,7 +40,7 @@ export interface Provider {
      */
     propertyMappings?: Array<string>;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof Provider
      */
@@ -58,19 +58,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/dist/esm/models/ProviderEnum.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `twilio` - Twilio
+ * * `generic` - Generic
  * @export
  */
 export declare const ProviderEnum: {

package/dist/esm/models/ProviderEnum.js

@@ -12,7 +12,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `twilio` - Twilio
+ * * `generic` - Generic
  * @export
  */
 export const ProviderEnum = {

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

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

package/dist/esm/models/ProviderTypeEnum.js

@@ -12,7 +12,18 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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/dist/esm/models/ProxyMode.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `proxy` - Proxy
+ * * `forward_single` - Forward Single
+ * * `forward_domain` - Forward Domain
  * @export
  */
 export declare const ProxyMode: {

package/dist/esm/models/ProxyMode.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `proxy` - Proxy
+ * * `forward_single` - Forward Single
+ * * `forward_domain` - Forward Domain
  * @export
  */
 export const ProxyMode = {

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

@@ -103,6 +103,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
      */
@@ -114,7 +118,7 @@ export interface ProxyOutpostConfig {
      */
     cookieDomain?: string;
     /**
-     *
+     * Get token validity as second count
      * @type {number}
      * @memberof ProxyOutpostConfig
      */
@@ -126,7 +130,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/dist/esm/models/ProxyProvider.d.ts

@@ -33,7 +33,7 @@ export interface ProxyProvider {
      * @type {string}
      * @memberof ProxyProvider
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -41,7 +41,7 @@ export interface ProxyProvider {
      */
     propertyMappings?: Array<string>;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof ProxyProvider
      */
@@ -59,19 +59,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
      */
@@ -132,6 +132,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
      */

package/dist/esm/models/ProxyProvider.js

@@ -23,7 +23,7 @@ export function ProxyProviderFromJSONTyped(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/ProxyProviderRequest.d.ts

@@ -27,7 +27,7 @@ export interface ProxyProviderRequest {
      * @type {string}
      * @memberof ProxyProviderRequest
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -84,6 +84,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
      */

package/dist/esm/models/ProxyProviderRequest.js

@@ -22,7 +22,7 @@ export function ProxyProviderRequestFromJSONTyped(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'],
         'internalHost': !exists(json, 'internal_host') ? undefined : json['internal_host'],
         'externalHost': json['external_host'],

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

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

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `discouraged` - Discouraged
+ * * `preferred` - Preferred
+ * * `required` - Required
  * @export
  */
 export declare const ResidentKeyRequirementEnum: {

package/dist/esm/models/ResidentKeyRequirementEnum.js

@@ -12,7 +12,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `discouraged` - Discouraged
+ * * `preferred` - Preferred
+ * * `required` - Required
  * @export
  */
 export const ResidentKeyRequirementEnum = {

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

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

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

@@ -35,7 +35,7 @@ export interface SAMLProvider {
      * @type {string}
      * @memberof SAMLProvider
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -43,7 +43,7 @@ export interface SAMLProvider {
      */
     propertyMappings?: Array<string>;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof SAMLProvider
      */
@@ -61,19 +61,19 @@ export interface SAMLProvider {
      */
     readonly assignedApplicationName: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof SAMLProvider
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof SAMLProvider
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof SAMLProvider
      */
@@ -146,42 +146,45 @@ export interface SAMLProvider {
     verificationKp?: string | null;
     /**
      * This determines how authentik sends the response back to the Service Provider.
+     *
+     * * `redirect` - Redirect
+     * * `post` - Post
      * @type {SpBindingEnum}
      * @memberof SAMLProvider
      */
     spBinding?: SpBindingEnum | null;
     /**
-     *
+     * Get metadata download URL
      * @type {string}
      * @memberof SAMLProvider
      */
     readonly urlDownloadMetadata: string;
     /**
-     *
+     * Get SSO Post URL
      * @type {string}
      * @memberof SAMLProvider
      */
     readonly urlSsoPost: string;
     /**
-     *
+     * Get SSO Redirect URL
      * @type {string}
      * @memberof SAMLProvider
      */
     readonly urlSsoRedirect: string;
     /**
-     *
+     * Get SSO IDP-Initiated URL
      * @type {string}
      * @memberof SAMLProvider
      */
     readonly urlSsoInit: string;
     /**
-     *
+     * Get SLO POST URL
      * @type {string}
      * @memberof SAMLProvider
      */
     readonly urlSloPost: string;
     /**
-     *
+     * Get SLO redirect URL
      * @type {string}
      * @memberof SAMLProvider
      */

package/dist/esm/models/SAMLProvider.js

@@ -25,7 +25,7 @@ export function SAMLProviderFromJSONTyped(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/SAMLProviderRequest.d.ts

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

package/dist/esm/models/SAMLProviderRequest.js

@@ -24,7 +24,7 @@ export function SAMLProviderRequestFromJSONTyped(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'],
         'acsUrl': json['acs_url'],
         'audience': !exists(json, 'audience') ? undefined : json['audience'],

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

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

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

@@ -59,6 +59,12 @@ export interface SAMLSourceRequest {
     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 SAMLSourceRequest
      */
@@ -101,6 +107,12 @@ export interface SAMLSourceRequest {
     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 SAMLSourceRequest
      */