@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/src/models/ServiceConnection.ts

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

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `notice` - Notice
+ * * `warning` - Warning
+ * * `alert` - Alert
  * @export
  */
 export const SeverityEnum = {

package/src/models/SignatureAlgorithmEnum.ts

@@ -14,7 +14,11 @@
 
 
 /**
- * 
+ * * `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 const SignatureAlgorithmEnum = {

package/src/models/Source.ts

@@ -69,25 +69,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
      */
@@ -100,6 +100,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
      */
@@ -117,7 +123,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/src/models/SourceRequest.ts

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

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `redirect` - Redirect
+ * * `post` - Post
  * @export
  */
 export const SpBindingEnum = {

package/src/models/Stage.ts

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

@@ -14,7 +14,11 @@
 
 
 /**
- * 
+ * * `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/src/models/System.ts

@@ -27,25 +27,25 @@ import {
  */
 export interface System {
     /**
-     * 
+     * Get Environment
      * @type {{ [key: string]: string; }}
      * @memberof System
      */
     readonly env: { [key: string]: string; };
     /**
-     * 
+     * Get HTTP Request headers
      * @type {{ [key: string]: string; }}
      * @memberof System
      */
     readonly httpHeaders: { [key: string]: string; };
     /**
-     * 
+     * Get HTTP host
      * @type {string}
      * @memberof System
      */
     readonly httpHost: string;
     /**
-     * 
+     * Get HTTP Secure flag
      * @type {boolean}
      * @memberof System
      */
@@ -57,19 +57,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/src/models/SystemRuntime.ts

@@ -14,7 +14,7 @@
 
 import { exists, mapValues } from '../runtime';
 /**
- * Runtime information
+ * Get versions
  * @export
  * @interface SystemRuntime
  */

package/src/models/Task.ts

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

package/src/models/TaskStatusEnum.ts

@@ -14,7 +14,10 @@
 
 
 /**
- * 
+ * * `SUCCESSFUL` - SUCCESSFUL
+ * * `WARNING` - WARNING
+ * * `ERROR` - ERROR
+ * * `UNKNOWN` - UNKNOWN
  * @export
  */
 export const TaskStatusEnum = {

package/src/models/TokenModel.ts

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

package/src/models/UsedByActionEnum.ts

@@ -14,7 +14,10 @@
 
 
 /**
- * 
+ * * `CASCADE` - CASCADE
+ * * `CASCADE_MANY` - CASCADE_MANY
+ * * `SET_NULL` - SET_NULL
+ * * `SET_DEFAULT` - SET_DEFAULT
  * @export
  */
 export const UsedByActionEnum = {

package/src/models/UserCreationModeEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `never_create` - Never Create
+ * * `create_when_required` - Create When Required
+ * * `always_create` - Always Create
  * @export
  */
 export const UserCreationModeEnum = {

package/src/models/UserDeleteStage.ts

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

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `email` - E Mail
+ * * `username` - Username
+ * * `upn` - Upn
  * @export
  */
 export const UserFieldsEnum = {

package/src/models/UserGroup.ts

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

package/src/models/UserLoginStage.ts

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

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

@@ -14,7 +14,11 @@
 
 
 /**
- * 
+ * * `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/src/models/UserSelf.ts

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

package/src/models/UserVerificationEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `required` - Required
+ * * `preferred` - Preferred
+ * * `discouraged` - Discouraged
  * @export
  */
 export const UserVerificationEnum = {

package/src/models/UserWriteStage.ts

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

@@ -20,25 +20,25 @@ import { exists, mapValues } from '../runtime';
  */
 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/src/models/index.ts

@@ -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';