@goauthentik/api 2024.8.3-1729167001 → 2024.8.3-1729699127

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

@@ -0,0 +1,198 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.8.3
+ * 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 type { GroupMatchingModeEnum } from './GroupMatchingModeEnum';
+import type { PolicyEngineMode } from './PolicyEngineMode';
+import type { UserMatchingModeEnum } from './UserMatchingModeEnum';
+/**
+ * Kerberos Source Serializer
+ * @export
+ * @interface KerberosSource
+ */
+export interface KerberosSource {
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    readonly pk: string;
+    /**
+     * Source's display Name.
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    name: string;
+    /**
+     * Internal source name, used in URLs.
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    slug: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof KerberosSource
+     */
+    enabled?: boolean;
+    /**
+     * Flow to use when authenticating existing users.
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    authenticationFlow?: string | null;
+    /**
+     * Flow to use when enrolling new users.
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    enrollmentFlow?: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof KerberosSource
+     */
+    userPropertyMappings?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof KerberosSource
+     */
+    groupPropertyMappings?: Array<string>;
+    /**
+     * Get object component so that we know how to edit the object
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    readonly component: string;
+    /**
+     * Return object's verbose_name
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    readonly verboseName: string;
+    /**
+     * Return object's plural verbose_name
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    readonly verboseNamePlural: string;
+    /**
+     * Return internal model name
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    readonly metaModelName: string;
+    /**
+     *
+     * @type {PolicyEngineMode}
+     * @memberof KerberosSource
+     */
+    policyEngineMode?: PolicyEngineMode;
+    /**
+     *
+     * @type {UserMatchingModeEnum}
+     * @memberof KerberosSource
+     */
+    userMatchingMode?: UserMatchingModeEnum;
+    /**
+     * Objects that are managed by authentik. These objects are created and updated automatically. This 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 KerberosSource
+     */
+    readonly managed: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    userPathTemplate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    readonly icon: string;
+    /**
+     *
+     * @type {GroupMatchingModeEnum}
+     * @memberof KerberosSource
+     */
+    groupMatchingMode?: GroupMatchingModeEnum;
+    /**
+     * Kerberos realm
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    realm: string;
+    /**
+     * Custom krb5.conf to use. Uses the system one by default
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    krb5Conf?: string;
+    /**
+     * Sync users from Kerberos into authentik
+     * @type {boolean}
+     * @memberof KerberosSource
+     */
+    syncUsers?: boolean;
+    /**
+     * When a user changes their password, sync it back to Kerberos
+     * @type {boolean}
+     * @memberof KerberosSource
+     */
+    syncUsersPassword?: boolean;
+    /**
+     * Principal to authenticate to kadmin for sync.
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    syncPrincipal?: string;
+    /**
+     * Credentials cache to authenticate to kadmin for sync. Must be in the form TYPE:residual
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    syncCcache?: string;
+    /**
+     * Get cached source connectivity
+     * @type {{ [key: string]: string; }}
+     * @memberof KerberosSource
+     */
+    readonly connectivity: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Force the use of a specific server name for SPNEGO
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    spnegoServerName?: string;
+    /**
+     * Credential cache to use for SPNEGO in form type:residual
+     * @type {string}
+     * @memberof KerberosSource
+     */
+    spnegoCcache?: string;
+    /**
+     * If enabled, the authentik-stored password will be updated upon login with the Kerberos password backend
+     * @type {boolean}
+     * @memberof KerberosSource
+     */
+    passwordLoginUpdateInternalPassword?: boolean;
+}
+/**
+ * Check if a given object implements the KerberosSource interface.
+ */
+export declare function instanceOfKerberosSource(value: object): boolean;
+export declare function KerberosSourceFromJSON(json: any): KerberosSource;
+export declare function KerberosSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): KerberosSource;
+export declare function KerberosSourceToJSON(value?: KerberosSource | null): any;

package/dist/esm/models/KerberosSource.js

@@ -0,0 +1,103 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.8.3
+ * 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';
+import { GroupMatchingModeEnumFromJSON, GroupMatchingModeEnumToJSON, } from './GroupMatchingModeEnum';
+import { PolicyEngineModeFromJSON, PolicyEngineModeToJSON, } from './PolicyEngineMode';
+import { UserMatchingModeEnumFromJSON, UserMatchingModeEnumToJSON, } from './UserMatchingModeEnum';
+/**
+ * Check if a given object implements the KerberosSource interface.
+ */
+export function instanceOfKerberosSource(value) {
+    let isInstance = true;
+    isInstance = isInstance && "pk" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "slug" in value;
+    isInstance = isInstance && "component" in value;
+    isInstance = isInstance && "verboseName" in value;
+    isInstance = isInstance && "verboseNamePlural" in value;
+    isInstance = isInstance && "metaModelName" in value;
+    isInstance = isInstance && "managed" in value;
+    isInstance = isInstance && "icon" in value;
+    isInstance = isInstance && "realm" in value;
+    isInstance = isInstance && "connectivity" in value;
+    return isInstance;
+}
+export function KerberosSourceFromJSON(json) {
+    return KerberosSourceFromJSONTyped(json, false);
+}
+export function KerberosSourceFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'pk': json['pk'],
+        'name': json['name'],
+        'slug': json['slug'],
+        'enabled': !exists(json, 'enabled') ? undefined : json['enabled'],
+        'authenticationFlow': !exists(json, 'authentication_flow') ? undefined : json['authentication_flow'],
+        'enrollmentFlow': !exists(json, 'enrollment_flow') ? undefined : json['enrollment_flow'],
+        'userPropertyMappings': !exists(json, 'user_property_mappings') ? undefined : json['user_property_mappings'],
+        'groupPropertyMappings': !exists(json, 'group_property_mappings') ? undefined : json['group_property_mappings'],
+        'component': json['component'],
+        'verboseName': json['verbose_name'],
+        'verboseNamePlural': json['verbose_name_plural'],
+        'metaModelName': json['meta_model_name'],
+        'policyEngineMode': !exists(json, 'policy_engine_mode') ? undefined : PolicyEngineModeFromJSON(json['policy_engine_mode']),
+        'userMatchingMode': !exists(json, 'user_matching_mode') ? undefined : UserMatchingModeEnumFromJSON(json['user_matching_mode']),
+        'managed': json['managed'],
+        'userPathTemplate': !exists(json, 'user_path_template') ? undefined : json['user_path_template'],
+        'icon': json['icon'],
+        'groupMatchingMode': !exists(json, 'group_matching_mode') ? undefined : GroupMatchingModeEnumFromJSON(json['group_matching_mode']),
+        'realm': json['realm'],
+        'krb5Conf': !exists(json, 'krb5_conf') ? undefined : json['krb5_conf'],
+        'syncUsers': !exists(json, 'sync_users') ? undefined : json['sync_users'],
+        'syncUsersPassword': !exists(json, 'sync_users_password') ? undefined : json['sync_users_password'],
+        'syncPrincipal': !exists(json, 'sync_principal') ? undefined : json['sync_principal'],
+        'syncCcache': !exists(json, 'sync_ccache') ? undefined : json['sync_ccache'],
+        'connectivity': json['connectivity'],
+        'spnegoServerName': !exists(json, 'spnego_server_name') ? undefined : json['spnego_server_name'],
+        'spnegoCcache': !exists(json, 'spnego_ccache') ? undefined : json['spnego_ccache'],
+        'passwordLoginUpdateInternalPassword': !exists(json, 'password_login_update_internal_password') ? undefined : json['password_login_update_internal_password'],
+    };
+}
+export function KerberosSourceToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'slug': value.slug,
+        'enabled': value.enabled,
+        'authentication_flow': value.authenticationFlow,
+        'enrollment_flow': value.enrollmentFlow,
+        'user_property_mappings': value.userPropertyMappings,
+        'group_property_mappings': value.groupPropertyMappings,
+        'policy_engine_mode': PolicyEngineModeToJSON(value.policyEngineMode),
+        'user_matching_mode': UserMatchingModeEnumToJSON(value.userMatchingMode),
+        'user_path_template': value.userPathTemplate,
+        'group_matching_mode': GroupMatchingModeEnumToJSON(value.groupMatchingMode),
+        'realm': value.realm,
+        'krb5_conf': value.krb5Conf,
+        'sync_users': value.syncUsers,
+        'sync_users_password': value.syncUsersPassword,
+        'sync_principal': value.syncPrincipal,
+        'sync_ccache': value.syncCcache,
+        'spnego_server_name': value.spnegoServerName,
+        'spnego_ccache': value.spnegoCcache,
+        'password_login_update_internal_password': value.passwordLoginUpdateInternalPassword,
+    };
+}

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

@@ -0,0 +1,73 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.8.3
+ * 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.
+ */
+/**
+ * Kerberos PropertyMapping Serializer
+ * @export
+ * @interface KerberosSourcePropertyMapping
+ */
+export interface KerberosSourcePropertyMapping {
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSourcePropertyMapping
+     */
+    readonly pk: string;
+    /**
+     * Objects that are managed by authentik. These objects are created and updated automatically. This 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 KerberosSourcePropertyMapping
+     */
+    managed?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSourcePropertyMapping
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSourcePropertyMapping
+     */
+    expression: string;
+    /**
+     * Get object's component so that we know how to edit the object
+     * @type {string}
+     * @memberof KerberosSourcePropertyMapping
+     */
+    readonly component: string;
+    /**
+     * Return object's verbose_name
+     * @type {string}
+     * @memberof KerberosSourcePropertyMapping
+     */
+    readonly verboseName: string;
+    /**
+     * Return object's plural verbose_name
+     * @type {string}
+     * @memberof KerberosSourcePropertyMapping
+     */
+    readonly verboseNamePlural: string;
+    /**
+     * Return internal model name
+     * @type {string}
+     * @memberof KerberosSourcePropertyMapping
+     */
+    readonly metaModelName: string;
+}
+/**
+ * Check if a given object implements the KerberosSourcePropertyMapping interface.
+ */
+export declare function instanceOfKerberosSourcePropertyMapping(value: object): boolean;
+export declare function KerberosSourcePropertyMappingFromJSON(json: any): KerberosSourcePropertyMapping;
+export declare function KerberosSourcePropertyMappingFromJSONTyped(json: any, ignoreDiscriminator: boolean): KerberosSourcePropertyMapping;
+export declare function KerberosSourcePropertyMappingToJSON(value?: KerberosSourcePropertyMapping | null): any;

package/dist/esm/models/KerberosSourcePropertyMapping.js

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.8.3
+ * 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';
+/**
+ * Check if a given object implements the KerberosSourcePropertyMapping interface.
+ */
+export function instanceOfKerberosSourcePropertyMapping(value) {
+    let isInstance = true;
+    isInstance = isInstance && "pk" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "expression" in value;
+    isInstance = isInstance && "component" in value;
+    isInstance = isInstance && "verboseName" in value;
+    isInstance = isInstance && "verboseNamePlural" in value;
+    isInstance = isInstance && "metaModelName" in value;
+    return isInstance;
+}
+export function KerberosSourcePropertyMappingFromJSON(json) {
+    return KerberosSourcePropertyMappingFromJSONTyped(json, false);
+}
+export function KerberosSourcePropertyMappingFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'pk': json['pk'],
+        'managed': !exists(json, 'managed') ? undefined : json['managed'],
+        'name': json['name'],
+        'expression': json['expression'],
+        'component': json['component'],
+        'verboseName': json['verbose_name'],
+        'verboseNamePlural': json['verbose_name_plural'],
+        'metaModelName': json['meta_model_name'],
+    };
+}
+export function KerberosSourcePropertyMappingToJSON(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/KerberosSourcePropertyMappingRequest.d.ts

@@ -0,0 +1,43 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.8.3
+ * 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.
+ */
+/**
+ * Kerberos PropertyMapping Serializer
+ * @export
+ * @interface KerberosSourcePropertyMappingRequest
+ */
+export interface KerberosSourcePropertyMappingRequest {
+    /**
+     * Objects that are managed by authentik. These objects are created and updated automatically. This 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 KerberosSourcePropertyMappingRequest
+     */
+    managed?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSourcePropertyMappingRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSourcePropertyMappingRequest
+     */
+    expression: string;
+}
+/**
+ * Check if a given object implements the KerberosSourcePropertyMappingRequest interface.
+ */
+export declare function instanceOfKerberosSourcePropertyMappingRequest(value: object): boolean;
+export declare function KerberosSourcePropertyMappingRequestFromJSON(json: any): KerberosSourcePropertyMappingRequest;
+export declare function KerberosSourcePropertyMappingRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): KerberosSourcePropertyMappingRequest;
+export declare function KerberosSourcePropertyMappingRequestToJSON(value?: KerberosSourcePropertyMappingRequest | null): any;

package/dist/esm/models/KerberosSourcePropertyMappingRequest.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.8.3
+ * 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';
+/**
+ * Check if a given object implements the KerberosSourcePropertyMappingRequest interface.
+ */
+export function instanceOfKerberosSourcePropertyMappingRequest(value) {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "expression" in value;
+    return isInstance;
+}
+export function KerberosSourcePropertyMappingRequestFromJSON(json) {
+    return KerberosSourcePropertyMappingRequestFromJSONTyped(json, false);
+}
+export function KerberosSourcePropertyMappingRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'managed': !exists(json, 'managed') ? undefined : json['managed'],
+        'name': json['name'],
+        'expression': json['expression'],
+    };
+}
+export function KerberosSourcePropertyMappingRequestToJSON(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/KerberosSourceRequest.d.ts

@@ -0,0 +1,166 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.8.3
+ * 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 type { GroupMatchingModeEnum } from './GroupMatchingModeEnum';
+import type { PolicyEngineMode } from './PolicyEngineMode';
+import type { UserMatchingModeEnum } from './UserMatchingModeEnum';
+/**
+ * Kerberos Source Serializer
+ * @export
+ * @interface KerberosSourceRequest
+ */
+export interface KerberosSourceRequest {
+    /**
+     * Source's display Name.
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    name: string;
+    /**
+     * Internal source name, used in URLs.
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    slug: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof KerberosSourceRequest
+     */
+    enabled?: boolean;
+    /**
+     * Flow to use when authenticating existing users.
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    authenticationFlow?: string | null;
+    /**
+     * Flow to use when enrolling new users.
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    enrollmentFlow?: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof KerberosSourceRequest
+     */
+    userPropertyMappings?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof KerberosSourceRequest
+     */
+    groupPropertyMappings?: Array<string>;
+    /**
+     *
+     * @type {PolicyEngineMode}
+     * @memberof KerberosSourceRequest
+     */
+    policyEngineMode?: PolicyEngineMode;
+    /**
+     *
+     * @type {UserMatchingModeEnum}
+     * @memberof KerberosSourceRequest
+     */
+    userMatchingMode?: UserMatchingModeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    userPathTemplate?: string;
+    /**
+     *
+     * @type {GroupMatchingModeEnum}
+     * @memberof KerberosSourceRequest
+     */
+    groupMatchingMode?: GroupMatchingModeEnum;
+    /**
+     * Kerberos realm
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    realm: string;
+    /**
+     * Custom krb5.conf to use. Uses the system one by default
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    krb5Conf?: string;
+    /**
+     * Sync users from Kerberos into authentik
+     * @type {boolean}
+     * @memberof KerberosSourceRequest
+     */
+    syncUsers?: boolean;
+    /**
+     * When a user changes their password, sync it back to Kerberos
+     * @type {boolean}
+     * @memberof KerberosSourceRequest
+     */
+    syncUsersPassword?: boolean;
+    /**
+     * Principal to authenticate to kadmin for sync.
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    syncPrincipal?: string;
+    /**
+     * Password to authenticate to kadmin for sync
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    syncPassword?: string;
+    /**
+     * Keytab to authenticate to kadmin for sync. Must be base64-encoded or in the form TYPE:residual
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    syncKeytab?: string;
+    /**
+     * Credentials cache to authenticate to kadmin for sync. Must be in the form TYPE:residual
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    syncCcache?: string;
+    /**
+     * Force the use of a specific server name for SPNEGO
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    spnegoServerName?: string;
+    /**
+     * SPNEGO keytab base64-encoded or path to keytab in the form FILE:path
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    spnegoKeytab?: string;
+    /**
+     * Credential cache to use for SPNEGO in form type:residual
+     * @type {string}
+     * @memberof KerberosSourceRequest
+     */
+    spnegoCcache?: string;
+    /**
+     * If enabled, the authentik-stored password will be updated upon login with the Kerberos password backend
+     * @type {boolean}
+     * @memberof KerberosSourceRequest
+     */
+    passwordLoginUpdateInternalPassword?: boolean;
+}
+/**
+ * Check if a given object implements the KerberosSourceRequest interface.
+ */
+export declare function instanceOfKerberosSourceRequest(value: object): boolean;
+export declare function KerberosSourceRequestFromJSON(json: any): KerberosSourceRequest;
+export declare function KerberosSourceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): KerberosSourceRequest;
+export declare function KerberosSourceRequestToJSON(value?: KerberosSourceRequest | null): any;