@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/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/models/SAMLProvider.js

@@ -29,7 +29,7 @@ function SAMLProviderFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'pk': json['pk'],
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !(0, runtime_1.exists)(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !(0, runtime_1.exists)(json, 'property_mappings') ? undefined : json['property_mappings'],
         'component': json['component'],
         'assignedApplicationSlug': json['assigned_application_slug'],

package/dist/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/models/SAMLProviderRequest.js

@@ -28,7 +28,7 @@ function SAMLProviderRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !(0, runtime_1.exists)(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !(0, runtime_1.exists)(json, 'property_mappings') ? undefined : json['property_mappings'],
         'acsUrl': json['acs_url'],
         'audience': !(0, runtime_1.exists)(json, 'audience') ? undefined : json['audience'],

package/dist/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/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
      */

package/dist/models/SCIMMapping.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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.
+ */
+/**
+ * SCIMMapping Serializer
+ * @export
+ * @interface SCIMMapping
+ */
+export interface SCIMMapping {
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMMapping
+     */
+    readonly pk: string;
+    /**
+     * 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 SCIMMapping
+     */
+    managed?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMMapping
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMMapping
+     */
+    expression: string;
+    /**
+     * Get object's component so that we know how to edit the object
+     * @type {string}
+     * @memberof SCIMMapping
+     */
+    readonly component: string;
+    /**
+     * Return object's verbose_name
+     * @type {string}
+     * @memberof SCIMMapping
+     */
+    readonly verboseName: string;
+    /**
+     * Return object's plural verbose_name
+     * @type {string}
+     * @memberof SCIMMapping
+     */
+    readonly verboseNamePlural: string;
+    /**
+     * Return internal model name
+     * @type {string}
+     * @memberof SCIMMapping
+     */
+    readonly metaModelName: string;
+}
+export declare function SCIMMappingFromJSON(json: any): SCIMMapping;
+export declare function SCIMMappingFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMMapping;
+export declare function SCIMMappingToJSON(value?: SCIMMapping | null): any;

package/dist/models/SCIMMapping.js

@@ -0,0 +1,51 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SCIMMappingToJSON = exports.SCIMMappingFromJSONTyped = exports.SCIMMappingFromJSON = void 0;
+const runtime_1 = require("../runtime");
+function SCIMMappingFromJSON(json) {
+    return SCIMMappingFromJSONTyped(json, false);
+}
+exports.SCIMMappingFromJSON = SCIMMappingFromJSON;
+function SCIMMappingFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'pk': json['pk'],
+        'managed': !(0, runtime_1.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'],
+    };
+}
+exports.SCIMMappingFromJSONTyped = SCIMMappingFromJSONTyped;
+function SCIMMappingToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'managed': value.managed,
+        'name': value.name,
+        'expression': value.expression,
+    };
+}
+exports.SCIMMappingToJSON = SCIMMappingToJSON;

package/dist/models/SCIMMappingRequest.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+/**
+ * SCIMMapping Serializer
+ * @export
+ * @interface SCIMMappingRequest
+ */
+export interface SCIMMappingRequest {
+    /**
+     * 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 SCIMMappingRequest
+     */
+    managed?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMMappingRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMMappingRequest
+     */
+    expression: string;
+}
+export declare function SCIMMappingRequestFromJSON(json: any): SCIMMappingRequest;
+export declare function SCIMMappingRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMMappingRequest;
+export declare function SCIMMappingRequestToJSON(value?: SCIMMappingRequest | null): any;

package/dist/models/SCIMMappingRequest.js

@@ -0,0 +1,46 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SCIMMappingRequestToJSON = exports.SCIMMappingRequestFromJSONTyped = exports.SCIMMappingRequestFromJSON = void 0;
+const runtime_1 = require("../runtime");
+function SCIMMappingRequestFromJSON(json) {
+    return SCIMMappingRequestFromJSONTyped(json, false);
+}
+exports.SCIMMappingRequestFromJSON = SCIMMappingRequestFromJSON;
+function SCIMMappingRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'managed': !(0, runtime_1.exists)(json, 'managed') ? undefined : json['managed'],
+        'name': json['name'],
+        'expression': json['expression'],
+    };
+}
+exports.SCIMMappingRequestFromJSONTyped = SCIMMappingRequestFromJSONTyped;
+function SCIMMappingRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'managed': value.managed,
+        'name': value.name,
+        'expression': value.expression,
+    };
+}
+exports.SCIMMappingRequestToJSON = SCIMMappingRequestToJSON;

package/dist/models/SCIMProvider.d.ts

@@ -0,0 +1,105 @@
+/**
+ * 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.
+ */
+/**
+ * SCIMProvider Serializer
+ * @export
+ * @interface SCIMProvider
+ */
+export interface SCIMProvider {
+    /**
+     *
+     * @type {number}
+     * @memberof SCIMProvider
+     */
+    readonly pk: number;
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof SCIMProvider
+     */
+    propertyMappings?: Array<string>;
+    /**
+     * Property mappings used for group creation/updating.
+     * @type {Array<string>}
+     * @memberof SCIMProvider
+     */
+    propertyMappingsGroup?: Array<string>;
+    /**
+     * Get object component so that we know how to edit the object
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    readonly component: string;
+    /**
+     * Internal application name, used in URLs.
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    readonly assignedApplicationSlug: string;
+    /**
+     * Application's display Name.
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    readonly assignedApplicationName: string;
+    /**
+     * Return object's verbose_name
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    readonly verboseName: string;
+    /**
+     * Return object's plural verbose_name
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    readonly verboseNamePlural: string;
+    /**
+     * Return internal model name
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    readonly metaModelName: string;
+    /**
+     * Base URL to SCIM requests, usually ends in /v2
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    url: string;
+    /**
+     * Authentication token
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    token: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SCIMProvider
+     */
+    excludeUsersServiceAccount?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMProvider
+     */
+    filterGroup?: string | null;
+}
+export declare function SCIMProviderFromJSON(json: any): SCIMProvider;
+export declare function SCIMProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMProvider;
+export declare function SCIMProviderToJSON(value?: SCIMProvider | null): any;

package/dist/models/SCIMProvider.js

@@ -0,0 +1,61 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SCIMProviderToJSON = exports.SCIMProviderFromJSONTyped = exports.SCIMProviderFromJSON = void 0;
+const runtime_1 = require("../runtime");
+function SCIMProviderFromJSON(json) {
+    return SCIMProviderFromJSONTyped(json, false);
+}
+exports.SCIMProviderFromJSON = SCIMProviderFromJSON;
+function SCIMProviderFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'pk': json['pk'],
+        'name': json['name'],
+        'propertyMappings': !(0, runtime_1.exists)(json, 'property_mappings') ? undefined : json['property_mappings'],
+        'propertyMappingsGroup': !(0, runtime_1.exists)(json, 'property_mappings_group') ? undefined : json['property_mappings_group'],
+        'component': json['component'],
+        'assignedApplicationSlug': json['assigned_application_slug'],
+        'assignedApplicationName': json['assigned_application_name'],
+        'verboseName': json['verbose_name'],
+        'verboseNamePlural': json['verbose_name_plural'],
+        'metaModelName': json['meta_model_name'],
+        'url': json['url'],
+        'token': json['token'],
+        'excludeUsersServiceAccount': !(0, runtime_1.exists)(json, 'exclude_users_service_account') ? undefined : json['exclude_users_service_account'],
+        'filterGroup': !(0, runtime_1.exists)(json, 'filter_group') ? undefined : json['filter_group'],
+    };
+}
+exports.SCIMProviderFromJSONTyped = SCIMProviderFromJSONTyped;
+function SCIMProviderToJSON(value) {
+    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,
+    };
+}
+exports.SCIMProviderToJSON = SCIMProviderToJSON;

package/dist/models/SCIMProviderRequest.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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.
+ */
+/**
+ * SCIMProvider Serializer
+ * @export
+ * @interface SCIMProviderRequest
+ */
+export interface SCIMProviderRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMProviderRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof SCIMProviderRequest
+     */
+    propertyMappings?: Array<string>;
+    /**
+     * Property mappings used for group creation/updating.
+     * @type {Array<string>}
+     * @memberof SCIMProviderRequest
+     */
+    propertyMappingsGroup?: Array<string>;
+    /**
+     * Base URL to SCIM requests, usually ends in /v2
+     * @type {string}
+     * @memberof SCIMProviderRequest
+     */
+    url: string;
+    /**
+     * Authentication token
+     * @type {string}
+     * @memberof SCIMProviderRequest
+     */
+    token: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SCIMProviderRequest
+     */
+    excludeUsersServiceAccount?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SCIMProviderRequest
+     */
+    filterGroup?: string | null;
+}
+export declare function SCIMProviderRequestFromJSON(json: any): SCIMProviderRequest;
+export declare function SCIMProviderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMProviderRequest;
+export declare function SCIMProviderRequestToJSON(value?: SCIMProviderRequest | null): any;