@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/esm/models/NotificationTransportModeEnum.js

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

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

@@ -35,7 +35,7 @@ export interface OAuth2Provider {
      * @type {string}
      * @memberof OAuth2Provider
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -43,7 +43,7 @@ export interface OAuth2Provider {
      */
     propertyMappings?: Array<string>;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof OAuth2Provider
      */
@@ -61,25 +61,28 @@ export interface OAuth2Provider {
      */
     readonly assignedApplicationName: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof OAuth2Provider
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof OAuth2Provider
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof OAuth2Provider
      */
     readonly metaModelName: string;
     /**
      * Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
+     *
+     * * `confidential` - Confidential
+     * * `public` - Public
      * @type {ClientTypeEnum}
      * @memberof OAuth2Provider
      */
@@ -134,12 +137,21 @@ export interface OAuth2Provider {
     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 OAuth2Provider
      */
     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 OAuth2Provider
      */

package/dist/esm/models/OAuth2Provider.js

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

@@ -29,7 +29,7 @@ export interface OAuth2ProviderRequest {
      * @type {string}
      * @memberof OAuth2ProviderRequest
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -38,6 +38,9 @@ export interface OAuth2ProviderRequest {
     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 OAuth2ProviderRequest
      */
@@ -92,12 +95,21 @@ export interface OAuth2ProviderRequest {
     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 OAuth2ProviderRequest
      */
     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 OAuth2ProviderRequest
      */

package/dist/esm/models/OAuth2ProviderRequest.js

@@ -24,7 +24,7 @@ export function OAuth2ProviderRequestFromJSONTyped(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'],
         'clientType': !exists(json, 'client_type') ? undefined : ClientTypeEnumFromJSON(json['client_type']),
         'clientId': !exists(json, 'client_id') ? undefined : json['client_id'],

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

@@ -56,25 +56,25 @@ export interface OAuthSource {
      */
     enrollmentFlow?: string | null;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof OAuthSource
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof OAuthSource
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof OAuthSource
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof OAuthSource
      */
@@ -87,6 +87,12 @@ export interface OAuthSource {
     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 OAuthSource
      */
@@ -104,7 +110,8 @@ export interface OAuthSource {
      */
     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 OAuthSource
      */
@@ -146,7 +153,7 @@ export interface OAuthSource {
      */
     consumerKey: string;
     /**
-     *
+     * Get OAuth Callback URL
      * @type {string}
      * @memberof OAuthSource
      */

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

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

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

@@ -61,7 +61,7 @@ export interface Outpost {
      */
     serviceConnectionObj: OutpostServiceConnectionObj;
     /**
-     *
+     * Get Token identifier
      * @type {string}
      * @memberof Outpost
      */

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

@@ -34,25 +34,25 @@ export interface OutpostServiceConnectionObj {
      */
     local?: boolean;
     /**
-     *
+     * Return component used to edit this object
      * @type {string}
      * @memberof OutpostServiceConnectionObj
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof OutpostServiceConnectionObj
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof OutpostServiceConnectionObj
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof OutpostServiceConnectionObj
      */

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

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `proxy` - Proxy
+ * * `ldap` - Ldap
  * @export
  */
 export declare const OutpostTypeEnum: {

package/dist/esm/models/OutpostTypeEnum.js

@@ -12,7 +12,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `proxy` - Proxy
+ * * `ldap` - Ldap
  * @export
  */
 export const OutpostTypeEnum = {

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

@@ -0,0 +1,35 @@
+/**
+ * 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 { PaginatedApplicationListPagination } from './PaginatedApplicationListPagination';
+import { SCIMMapping } from './SCIMMapping';
+/**
+ *
+ * @export
+ * @interface PaginatedSCIMMappingList
+ */
+export interface PaginatedSCIMMappingList {
+    /**
+     *
+     * @type {PaginatedApplicationListPagination}
+     * @memberof PaginatedSCIMMappingList
+     */
+    pagination: PaginatedApplicationListPagination;
+    /**
+     *
+     * @type {Array<SCIMMapping>}
+     * @memberof PaginatedSCIMMappingList
+     */
+    results: Array<SCIMMapping>;
+}
+export declare function PaginatedSCIMMappingListFromJSON(json: any): PaginatedSCIMMappingList;
+export declare function PaginatedSCIMMappingListFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedSCIMMappingList;
+export declare function PaginatedSCIMMappingListToJSON(value?: PaginatedSCIMMappingList | null): any;

package/dist/esm/models/PaginatedSCIMMappingList.js

@@ -0,0 +1,39 @@
+/* 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 { PaginatedApplicationListPaginationFromJSON, PaginatedApplicationListPaginationToJSON, } from './PaginatedApplicationListPagination';
+import { SCIMMappingFromJSON, SCIMMappingToJSON, } from './SCIMMapping';
+export function PaginatedSCIMMappingListFromJSON(json) {
+    return PaginatedSCIMMappingListFromJSONTyped(json, false);
+}
+export function PaginatedSCIMMappingListFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'pagination': PaginatedApplicationListPaginationFromJSON(json['pagination']),
+        'results': (json['results'].map(SCIMMappingFromJSON)),
+    };
+}
+export function PaginatedSCIMMappingListToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'pagination': PaginatedApplicationListPaginationToJSON(value.pagination),
+        'results': (value.results.map(SCIMMappingToJSON)),
+    };
+}

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

@@ -0,0 +1,35 @@
+/**
+ * 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 { PaginatedApplicationListPagination } from './PaginatedApplicationListPagination';
+import { SCIMProvider } from './SCIMProvider';
+/**
+ *
+ * @export
+ * @interface PaginatedSCIMProviderList
+ */
+export interface PaginatedSCIMProviderList {
+    /**
+     *
+     * @type {PaginatedApplicationListPagination}
+     * @memberof PaginatedSCIMProviderList
+     */
+    pagination: PaginatedApplicationListPagination;
+    /**
+     *
+     * @type {Array<SCIMProvider>}
+     * @memberof PaginatedSCIMProviderList
+     */
+    results: Array<SCIMProvider>;
+}
+export declare function PaginatedSCIMProviderListFromJSON(json: any): PaginatedSCIMProviderList;
+export declare function PaginatedSCIMProviderListFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedSCIMProviderList;
+export declare function PaginatedSCIMProviderListToJSON(value?: PaginatedSCIMProviderList | null): any;

package/dist/esm/models/PaginatedSCIMProviderList.js

@@ -0,0 +1,39 @@
+/* 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 { PaginatedApplicationListPaginationFromJSON, PaginatedApplicationListPaginationToJSON, } from './PaginatedApplicationListPagination';
+import { SCIMProviderFromJSON, SCIMProviderToJSON, } from './SCIMProvider';
+export function PaginatedSCIMProviderListFromJSON(json) {
+    return PaginatedSCIMProviderListFromJSONTyped(json, false);
+}
+export function PaginatedSCIMProviderListFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'pagination': PaginatedApplicationListPaginationFromJSON(json['pagination']),
+        'results': (json['results'].map(SCIMProviderFromJSON)),
+    };
+}
+export function PaginatedSCIMProviderListToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'pagination': PaginatedApplicationListPaginationToJSON(value.pagination),
+        'results': (value.results.map(SCIMProviderToJSON)),
+    };
+}

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

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

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

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

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

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

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

@@ -57,6 +57,10 @@ export interface PatchedAuthenticatorValidateStageRequest {
     lastAuthThreshold?: string;
     /**
      * Enforce user verification for WebAuthn devices.
+     *
+     * * `required` - Required
+     * * `preferred` - Preferred
+     * * `discouraged` - Discouraged
      * @type {UserVerificationEnum}
      * @memberof PatchedAuthenticatorValidateStageRequest
      */

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

@@ -31,6 +31,34 @@ export interface PatchedEventMatcherPolicyRequest {
     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 PatchedEventMatcherPolicyRequest
      */
@@ -43,6 +71,53 @@ export interface PatchedEventMatcherPolicyRequest {
     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 PatchedEventMatcherPolicyRequest
      */