@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/src/models/PaginatedSCIMProviderList.ts

@@ -0,0 +1,77 @@
+/* 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';
+import {
+    PaginatedApplicationListPagination,
+    PaginatedApplicationListPaginationFromJSON,
+    PaginatedApplicationListPaginationFromJSONTyped,
+    PaginatedApplicationListPaginationToJSON,
+} from './PaginatedApplicationListPagination';
+import {
+    SCIMProvider,
+    SCIMProviderFromJSON,
+    SCIMProviderFromJSONTyped,
+    SCIMProviderToJSON,
+} from './SCIMProvider';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedSCIMProviderList
+ */
+export interface PaginatedSCIMProviderList {
+    /**
+     * 
+     * @type {PaginatedApplicationListPagination}
+     * @memberof PaginatedSCIMProviderList
+     */
+    pagination: PaginatedApplicationListPagination;
+    /**
+     * 
+     * @type {Array<SCIMProvider>}
+     * @memberof PaginatedSCIMProviderList
+     */
+    results: Array<SCIMProvider>;
+}
+
+export function PaginatedSCIMProviderListFromJSON(json: any): PaginatedSCIMProviderList {
+    return PaginatedSCIMProviderListFromJSONTyped(json, false);
+}
+
+export function PaginatedSCIMProviderListFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedSCIMProviderList {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pagination': PaginatedApplicationListPaginationFromJSON(json['pagination']),
+        'results': ((json['results'] as Array<any>).map(SCIMProviderFromJSON)),
+    };
+}
+
+export function PaginatedSCIMProviderListToJSON(value?: PaginatedSCIMProviderList | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'pagination': PaginatedApplicationListPaginationToJSON(value.pagination),
+        'results': ((value.results as Array<any>).map(SCIMProviderToJSON)),
+    };
+}
+

package/src/models/PasswordExpiryPolicy.ts

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

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

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

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

package/src/models/PatchedEventMatcherPolicyRequest.ts

@@ -46,6 +46,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
      */
@@ -58,6 +86,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
      */

package/src/models/PatchedFlowRequest.ts

@@ -70,6 +70,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
      */
@@ -94,12 +102,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/src/models/PatchedFlowStageBindingRequest.ts

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

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

package/src/models/PatchedLDAPSourceRequest.ts

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

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

@@ -49,7 +49,7 @@ export interface PatchedOAuth2ProviderRequest {
      * @type {string}
      * @memberof PatchedOAuth2ProviderRequest
      */
-    authorizationFlow?: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -58,6 +58,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
      */
@@ -112,12 +115,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/src/models/PatchedOAuthSourceRequest.ts

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

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

@@ -37,7 +37,7 @@ export interface PatchedProxyProviderRequest {
      * @type {string}
      * @memberof PatchedProxyProviderRequest
      */
-    authorizationFlow?: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -94,6 +94,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/src/models/PatchedSAMLProviderRequest.ts

@@ -49,7 +49,7 @@ export interface PatchedSAMLProviderRequest {
      * @type {string}
      * @memberof PatchedSAMLProviderRequest
      */
-    authorizationFlow?: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -124,6 +124,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/src/models/PatchedSAMLSourceRequest.ts

@@ -94,6 +94,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
      */
@@ -136,6 +142,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/src/models/PatchedSCIMMappingRequest.ts

@@ -0,0 +1,72 @@
+/* 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';
+/**
+ * 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 function PatchedSCIMMappingRequestFromJSON(json: any): PatchedSCIMMappingRequest {
+    return PatchedSCIMMappingRequestFromJSONTyped(json, false);
+}
+
+export function PatchedSCIMMappingRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedSCIMMappingRequest {
+    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?: PatchedSCIMMappingRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'managed': value.managed,
+        'name': value.name,
+        'expression': value.expression,
+    };
+}
+