@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/models/SCIMProviderRequest.js

@@ -0,0 +1,54 @@
+"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.SCIMProviderRequestToJSON = exports.SCIMProviderRequestFromJSONTyped = exports.SCIMProviderRequestFromJSON = void 0;
+const runtime_1 = require("../runtime");
+function SCIMProviderRequestFromJSON(json) {
+    return SCIMProviderRequestFromJSONTyped(json, false);
+}
+exports.SCIMProviderRequestFromJSON = SCIMProviderRequestFromJSON;
+function SCIMProviderRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        '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'],
+        '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.SCIMProviderRequestFromJSONTyped = SCIMProviderRequestFromJSONTyped;
+function SCIMProviderRequestToJSON(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.SCIMProviderRequestToJSON = SCIMProviderRequestToJSON;

package/dist/models/ScopeMapping.d.ts

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

package/dist/models/ServiceConnection.d.ts

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

package/dist/models/SeverityEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `notice` - Notice
+ * * `warning` - Warning
+ * * `alert` - Alert
  * @export
  */
 export declare const SeverityEnum: {

package/dist/models/SeverityEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SeverityEnumToJSON = exports.SeverityEnumFromJSONTyped = exports.SeverityEnumFromJSON = exports.SeverityEnum = void 0;
 /**
- *
+ * * `notice` - Notice
+ * * `warning` - Warning
+ * * `alert` - Alert
  * @export
  */
 exports.SeverityEnum = {

package/dist/models/SignatureAlgorithmEnum.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `http://www.w3.org/2000/09/xmldsig#rsa-sha1` - RSA-SHA1
+ * * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` - RSA-SHA256
+ * * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384` - RSA-SHA384
+ * * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512` - RSA-SHA512
+ * * `http://www.w3.org/2000/09/xmldsig#dsa-sha1` - DSA-SHA1
  * @export
  */
 export declare const SignatureAlgorithmEnum: {

package/dist/models/SignatureAlgorithmEnum.js

@@ -15,7 +15,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SignatureAlgorithmEnumToJSON = exports.SignatureAlgorithmEnumFromJSONTyped = exports.SignatureAlgorithmEnumFromJSON = exports.SignatureAlgorithmEnum = void 0;
 /**
- *
+ * * `http://www.w3.org/2000/09/xmldsig#rsa-sha1` - RSA-SHA1
+ * * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` - RSA-SHA256
+ * * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384` - RSA-SHA384
+ * * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512` - RSA-SHA512
+ * * `http://www.w3.org/2000/09/xmldsig#dsa-sha1` - DSA-SHA1
  * @export
  */
 exports.SignatureAlgorithmEnum = {

package/dist/models/Source.d.ts

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

package/dist/models/SourceRequest.d.ts

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

package/dist/models/SpBindingEnum.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `redirect` - Redirect
+ * * `post` - Post
  * @export
  */
 export declare const SpBindingEnum: {

package/dist/models/SpBindingEnum.js

@@ -15,7 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SpBindingEnumToJSON = exports.SpBindingEnumFromJSONTyped = exports.SpBindingEnumFromJSON = exports.SpBindingEnum = void 0;
 /**
- *
+ * * `redirect` - Redirect
+ * * `post` - Post
  * @export
  */
 exports.SpBindingEnum = {

package/dist/models/Stage.d.ts

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

package/dist/models/SubModeEnum.d.ts

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

package/dist/models/SubModeEnum.js

@@ -15,7 +15,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubModeEnumToJSON = exports.SubModeEnumFromJSONTyped = exports.SubModeEnumFromJSON = exports.SubModeEnum = void 0;
 /**
- *
+ * * `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.
  * @export
  */
 exports.SubModeEnum = {

package/dist/models/System.d.ts

@@ -17,7 +17,7 @@ import { SystemRuntime } from './SystemRuntime';
  */
 export interface System {
     /**
-     *
+     * Get Environment
      * @type {{ [key: string]: string; }}
      * @memberof System
      */
@@ -25,7 +25,7 @@ export interface System {
         [key: string]: string;
     };
     /**
-     *
+     * Get HTTP Request headers
      * @type {{ [key: string]: string; }}
      * @memberof System
      */
@@ -33,13 +33,13 @@ export interface System {
         [key: string]: string;
     };
     /**
-     *
+     * Get HTTP host
      * @type {string}
      * @memberof System
      */
     readonly httpHost: string;
     /**
-     *
+     * Get HTTP Secure flag
      * @type {boolean}
      * @memberof System
      */
@@ -51,19 +51,19 @@ export interface System {
      */
     runtime: SystemRuntime;
     /**
-     *
+     * Currently active tenant
      * @type {string}
      * @memberof System
      */
     readonly tenant: string;
     /**
-     *
+     * Current server time
      * @type {Date}
      * @memberof System
      */
     readonly serverTime: Date;
     /**
-     *
+     * Get the FQDN configured on the embedded outpost
      * @type {string}
      * @memberof System
      */

package/dist/models/SystemRuntime.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Runtime information
+ * Get versions
  * @export
  * @interface SystemRuntime
  */

package/dist/models/Task.d.ts

@@ -35,7 +35,7 @@ export interface Task {
      */
     taskFinishTimestamp: Date;
     /**
-     *
+     * Get the duration a task took to run
      * @type {number}
      * @memberof Task
      */

package/dist/models/TaskStatusEnum.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `SUCCESSFUL` - SUCCESSFUL
+ * * `WARNING` - WARNING
+ * * `ERROR` - ERROR
+ * * `UNKNOWN` - UNKNOWN
  * @export
  */
 export declare const TaskStatusEnum: {

package/dist/models/TaskStatusEnum.js

@@ -15,7 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TaskStatusEnumToJSON = exports.TaskStatusEnumFromJSONTyped = exports.TaskStatusEnumFromJSON = exports.TaskStatusEnum = void 0;
 /**
- *
+ * * `SUCCESSFUL` - SUCCESSFUL
+ * * `WARNING` - WARNING
+ * * `ERROR` - ERROR
+ * * `UNKNOWN` - UNKNOWN
  * @export
  */
 exports.TaskStatusEnum = {

package/dist/models/TokenModel.d.ts

@@ -36,7 +36,7 @@ export interface TokenModel {
      */
     user: User;
     /**
-     *
+     * Check if token is expired yet.
      * @type {boolean}
      * @memberof TokenModel
      */
@@ -54,7 +54,7 @@ export interface TokenModel {
      */
     scope: Array<string>;
     /**
-     *
+     * Get the token's id_token as JSON String
      * @type {string}
      * @memberof TokenModel
      */

package/dist/models/UsedByActionEnum.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `CASCADE` - CASCADE
+ * * `CASCADE_MANY` - CASCADE_MANY
+ * * `SET_NULL` - SET_NULL
+ * * `SET_DEFAULT` - SET_DEFAULT
  * @export
  */
 export declare const UsedByActionEnum: {

package/dist/models/UsedByActionEnum.js

@@ -15,7 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UsedByActionEnumToJSON = exports.UsedByActionEnumFromJSONTyped = exports.UsedByActionEnumFromJSON = exports.UsedByActionEnum = void 0;
 /**
- *
+ * * `CASCADE` - CASCADE
+ * * `CASCADE_MANY` - CASCADE_MANY
+ * * `SET_NULL` - SET_NULL
+ * * `SET_DEFAULT` - SET_DEFAULT
  * @export
  */
 exports.UsedByActionEnum = {

package/dist/models/UserCreationModeEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `never_create` - Never Create
+ * * `create_when_required` - Create When Required
+ * * `always_create` - Always Create
  * @export
  */
 export declare const UserCreationModeEnum: {

package/dist/models/UserCreationModeEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserCreationModeEnumToJSON = exports.UserCreationModeEnumFromJSONTyped = exports.UserCreationModeEnumFromJSON = exports.UserCreationModeEnum = void 0;
 /**
- *
+ * * `never_create` - Never Create
+ * * `create_when_required` - Create When Required
+ * * `always_create` - Always Create
  * @export
  */
 exports.UserCreationModeEnum = {

package/dist/models/UserDeleteStage.d.ts

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

package/dist/models/UserFieldsEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `email` - E Mail
+ * * `username` - Username
+ * * `upn` - Upn
  * @export
  */
 export declare const UserFieldsEnum: {

package/dist/models/UserFieldsEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserFieldsEnumToJSON = exports.UserFieldsEnumFromJSONTyped = exports.UserFieldsEnumFromJSON = exports.UserFieldsEnum = void 0;
 /**
- *
+ * * `email` - E Mail
+ * * `username` - Username
+ * * `upn` - Upn
  * @export
  */
 exports.UserFieldsEnum = {

package/dist/models/UserGroup.d.ts

@@ -22,7 +22,7 @@ export interface UserGroup {
      */
     readonly pk: string;
     /**
-     *
+     * Get a numerical, int32 ID for the group
      * @type {number}
      * @memberof UserGroup
      */

package/dist/models/UserLoginStage.d.ts

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

package/dist/models/UserLogoutStage.d.ts

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

package/dist/models/UserMatchingModeEnum.d.ts

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

package/dist/models/UserMatchingModeEnum.js

@@ -15,7 +15,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserMatchingModeEnumToJSON = exports.UserMatchingModeEnumFromJSONTyped = exports.UserMatchingModeEnumFromJSON = exports.UserMatchingModeEnum = void 0;
 /**
- *
+ * * `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.
  * @export
  */
 exports.UserMatchingModeEnum = {

package/dist/models/UserSelf.d.ts

@@ -71,7 +71,7 @@ export interface UserSelf {
      */
     readonly uid: string;
     /**
-     *
+     * Get user settings with tenant and group settings applied
      * @type {{ [key: string]: any; }}
      * @memberof UserSelf
      */

package/dist/models/UserVerificationEnum.d.ts

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