@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

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

@@ -12,7 +12,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 const SubModeEnum = {

package/dist/esm/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/esm/models/SystemRuntime.d.ts

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

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

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

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

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

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

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

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

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

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

@@ -12,7 +12,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 const UserMatchingModeEnum = {

package/dist/esm/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/esm/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: {

package/dist/esm/models/UserVerificationEnum.js

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

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

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

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

@@ -16,25 +16,25 @@
  */
 export interface Version {
     /**
-     *
+     * Get current version
      * @type {string}
      * @memberof Version
      */
     readonly versionCurrent: string;
     /**
-     *
+     * Get latest version from cache
      * @type {string}
      * @memberof Version
      */
     readonly versionLatest: string;
     /**
-     *
+     * Get build hash, if version is not latest or released
      * @type {string}
      * @memberof Version
      */
     readonly buildHash: string;
     /**
-     *
+     * Check if we're running the latest version
      * @type {boolean}
      * @memberof Version
      */

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

@@ -249,6 +249,8 @@ export * from './PaginatedReputationPolicyList';
 export * from './PaginatedSAMLPropertyMappingList';
 export * from './PaginatedSAMLProviderList';
 export * from './PaginatedSAMLSourceList';
+export * from './PaginatedSCIMMappingList';
+export * from './PaginatedSCIMProviderList';
 export * from './PaginatedSMSDeviceList';
 export * from './PaginatedScopeMappingList';
 export * from './PaginatedServiceConnectionList';
@@ -327,6 +329,8 @@ export * from './PatchedReputationPolicyRequest';
 export * from './PatchedSAMLPropertyMappingRequest';
 export * from './PatchedSAMLProviderRequest';
 export * from './PatchedSAMLSourceRequest';
+export * from './PatchedSCIMMappingRequest';
+export * from './PatchedSCIMProviderRequest';
 export * from './PatchedSMSDeviceRequest';
 export * from './PatchedScopeMappingRequest';
 export * from './PatchedStaticDeviceRequest';
@@ -390,6 +394,10 @@ export * from './SAMLProvider';
 export * from './SAMLProviderRequest';
 export * from './SAMLSource';
 export * from './SAMLSourceRequest';
+export * from './SCIMMapping';
+export * from './SCIMMappingRequest';
+export * from './SCIMProvider';
+export * from './SCIMProviderRequest';
 export * from './SMSDevice';
 export * from './SMSDeviceRequest';
 export * from './ScopeMapping';

package/dist/esm/models/index.js

@@ -251,6 +251,8 @@ export * from './PaginatedReputationPolicyList';
 export * from './PaginatedSAMLPropertyMappingList';
 export * from './PaginatedSAMLProviderList';
 export * from './PaginatedSAMLSourceList';
+export * from './PaginatedSCIMMappingList';
+export * from './PaginatedSCIMProviderList';
 export * from './PaginatedSMSDeviceList';
 export * from './PaginatedScopeMappingList';
 export * from './PaginatedServiceConnectionList';
@@ -329,6 +331,8 @@ export * from './PatchedReputationPolicyRequest';
 export * from './PatchedSAMLPropertyMappingRequest';
 export * from './PatchedSAMLProviderRequest';
 export * from './PatchedSAMLSourceRequest';
+export * from './PatchedSCIMMappingRequest';
+export * from './PatchedSCIMProviderRequest';
 export * from './PatchedSMSDeviceRequest';
 export * from './PatchedScopeMappingRequest';
 export * from './PatchedStaticDeviceRequest';
@@ -392,6 +396,10 @@ export * from './SAMLProvider';
 export * from './SAMLProviderRequest';
 export * from './SAMLSource';
 export * from './SAMLSourceRequest';
+export * from './SCIMMapping';
+export * from './SCIMMappingRequest';
+export * from './SCIMProvider';
+export * from './SCIMProviderRequest';
 export * from './SMSDevice';
 export * from './SMSDeviceRequest';
 export * from './ScopeMapping';

package/dist/models/AppEnum.d.ts

@@ -10,7 +10,52 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `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
  * @export
  */
 export declare const AppEnum: {
@@ -32,6 +77,7 @@ export declare const AppEnum: {
     readonly ProvidersOauth2: "authentik.providers.oauth2";
     readonly ProvidersProxy: "authentik.providers.proxy";
     readonly ProvidersSaml: "authentik.providers.saml";
+    readonly ProvidersScim: "authentik.providers.scim";
     readonly Recovery: "authentik.recovery";
     readonly SourcesLdap: "authentik.sources.ldap";
     readonly SourcesOauth: "authentik.sources.oauth";

package/dist/models/AppEnum.js

@@ -15,7 +15,52 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppEnumToJSON = exports.AppEnumFromJSONTyped = exports.AppEnumFromJSON = exports.AppEnum = void 0;
 /**
- *
+ * * `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
  * @export
  */
 exports.AppEnum = {
@@ -37,6 +82,7 @@ exports.AppEnum = {
     ProvidersOauth2: 'authentik.providers.oauth2',
     ProvidersProxy: 'authentik.providers.proxy',
     ProvidersSaml: 'authentik.providers.saml',
+    ProvidersScim: 'authentik.providers.scim',
     Recovery: 'authentik.recovery',
     SourcesLdap: 'authentik.sources.ldap',
     SourcesOauth: 'authentik.sources.oauth',