@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/src/models/IssuerModeEnum.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `global` - Same identifier is used for all providers
+ * * `per_provider` - Each provider has a different issuer, based on the application slug.
  * @export
  */
 export const IssuerModeEnum = {

package/src/models/KubernetesServiceConnection.ts

@@ -44,19 +44,19 @@ export interface KubernetesServiceConnection {
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof KubernetesServiceConnection
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof KubernetesServiceConnection
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof KubernetesServiceConnection
      */

package/src/models/LDAPAPIAccessMode.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `direct` - Direct
+ * * `cached` - Cached
  * @export
  */
 export const LDAPAPIAccessMode = {

package/src/models/LDAPPropertyMapping.ts

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

package/src/models/LDAPProvider.ts

@@ -43,7 +43,7 @@ export interface LDAPProvider {
      * @type {string}
      * @memberof LDAPProvider
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -51,7 +51,7 @@ export interface LDAPProvider {
      */
     propertyMappings?: Array<string>;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof LDAPProvider
      */
@@ -69,19 +69,19 @@ export interface LDAPProvider {
      */
     readonly assignedApplicationName: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof LDAPProvider
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof LDAPProvider
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof LDAPProvider
      */
@@ -154,7 +154,7 @@ export function LDAPProviderFromJSONTyped(json: any, ignoreDiscriminator: boolea
         
         'pk': json['pk'],
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !exists(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !exists(json, 'property_mappings') ? undefined : json['property_mappings'],
         'component': json['component'],
         'assignedApplicationSlug': json['assigned_application_slug'],

package/src/models/LDAPProviderRequest.ts

@@ -37,7 +37,7 @@ export interface LDAPProviderRequest {
      * @type {string}
      * @memberof LDAPProviderRequest
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -105,7 +105,7 @@ export function LDAPProviderRequestFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !exists(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !exists(json, 'property_mappings') ? undefined : json['property_mappings'],
         'baseDn': !exists(json, 'base_dn') ? undefined : json['base_dn'],
         'searchGroup': !exists(json, 'search_group') ? undefined : json['search_group'],

package/src/models/LDAPSource.ts

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

package/src/models/LDAPSourceRequest.ts

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

package/src/models/LayoutEnum.ts

@@ -14,7 +14,11 @@
 
 
 /**
- * 
+ * * `stacked` - STACKED
+ * * `content_left` - CONTENT_LEFT
+ * * `content_right` - CONTENT_RIGHT
+ * * `sidebar_left` - SIDEBAR_LEFT
+ * * `sidebar_right` - SIDEBAR_RIGHT
  * @export
  */
 export const LayoutEnum = {

package/src/models/NameIdPolicyEnum.ts

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

package/src/models/NotConfiguredActionEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `skip` - Skip
+ * * `deny` - Deny
+ * * `configure` - Configure
  * @export
  */
 export const NotConfiguredActionEnum = {

package/src/models/NotificationRule.ts

@@ -52,6 +52,10 @@ export interface NotificationRule {
     transports?: Array<string>;
     /**
      * Controls which severity level the created notifications will have.
+     * 
+     * * `notice` - Notice
+     * * `warning` - Warning
+     * * `alert` - Alert
      * @type {SeverityEnum}
      * @memberof NotificationRule
      */

package/src/models/NotificationRuleRequest.ts

@@ -40,6 +40,10 @@ export interface NotificationRuleRequest {
     transports?: Array<string>;
     /**
      * Controls which severity level the created notifications will have.
+     * 
+     * * `notice` - Notice
+     * * `warning` - Warning
+     * * `alert` - Alert
      * @type {SeverityEnum}
      * @memberof NotificationRuleRequest
      */

package/src/models/NotificationTransport.ts

@@ -45,7 +45,7 @@ export interface NotificationTransport {
      */
     mode?: NotificationTransportModeEnum;
     /**
-     * 
+     * Return selected mode with a UI Label
      * @type {string}
      * @memberof NotificationTransport
      */

package/src/models/NotificationTransportModeEnum.ts

@@ -14,7 +14,10 @@
 
 
 /**
- * 
+ * * `local` - authentik inbuilt notifications
+ * * `webhook` - Generic Webhook
+ * * `webhook_slack` - Slack Webhook (Slack/Discord)
+ * * `email` - Email
  * @export
  */
 export const NotificationTransportModeEnum = {

package/src/models/OAuth2Provider.ts

@@ -55,7 +55,7 @@ export interface OAuth2Provider {
      * @type {string}
      * @memberof OAuth2Provider
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -63,7 +63,7 @@ export interface OAuth2Provider {
      */
     propertyMappings?: Array<string>;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof OAuth2Provider
      */
@@ -81,25 +81,28 @@ export interface OAuth2Provider {
      */
     readonly assignedApplicationName: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof OAuth2Provider
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof OAuth2Provider
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof OAuth2Provider
      */
     readonly metaModelName: string;
     /**
      * Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
+     * 
+     * * `confidential` - Confidential
+     * * `public` - Public
      * @type {ClientTypeEnum}
      * @memberof OAuth2Provider
      */
@@ -154,12 +157,21 @@ export interface OAuth2Provider {
     redirectUris?: string;
     /**
      * Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
+     * 
+     * * `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.
      * @type {SubModeEnum}
      * @memberof OAuth2Provider
      */
     subMode?: SubModeEnum | null;
     /**
      * Configure how the issuer field of the ID Token should be filled.
+     * 
+     * * `global` - Same identifier is used for all providers
+     * * `per_provider` - Each provider has a different issuer, based on the application slug.
      * @type {IssuerModeEnum}
      * @memberof OAuth2Provider
      */
@@ -184,7 +196,7 @@ export function OAuth2ProviderFromJSONTyped(json: any, ignoreDiscriminator: bool
         
         'pk': json['pk'],
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !exists(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !exists(json, 'property_mappings') ? undefined : json['property_mappings'],
         'component': json['component'],
         'assignedApplicationSlug': json['assigned_application_slug'],

package/src/models/OAuth2ProviderRequest.ts

@@ -49,7 +49,7 @@ export interface OAuth2ProviderRequest {
      * @type {string}
      * @memberof OAuth2ProviderRequest
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -58,6 +58,9 @@ export interface OAuth2ProviderRequest {
     propertyMappings?: Array<string>;
     /**
      * Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
+     * 
+     * * `confidential` - Confidential
+     * * `public` - Public
      * @type {ClientTypeEnum}
      * @memberof OAuth2ProviderRequest
      */
@@ -112,12 +115,21 @@ export interface OAuth2ProviderRequest {
     redirectUris?: string;
     /**
      * Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
+     * 
+     * * `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.
      * @type {SubModeEnum}
      * @memberof OAuth2ProviderRequest
      */
     subMode?: SubModeEnum | null;
     /**
      * Configure how the issuer field of the ID Token should be filled.
+     * 
+     * * `global` - Same identifier is used for all providers
+     * * `per_provider` - Each provider has a different issuer, based on the application slug.
      * @type {IssuerModeEnum}
      * @memberof OAuth2ProviderRequest
      */
@@ -141,7 +153,7 @@ export function OAuth2ProviderRequestFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !exists(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !exists(json, 'property_mappings') ? undefined : json['property_mappings'],
         'clientType': !exists(json, 'client_type') ? undefined : ClientTypeEnumFromJSON(json['client_type']),
         'clientId': !exists(json, 'client_id') ? undefined : json['client_id'],

package/src/models/OAuthSource.ts

@@ -81,25 +81,25 @@ export interface OAuthSource {
      */
     enrollmentFlow?: string | null;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof OAuthSource
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof OAuthSource
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof OAuthSource
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof OAuthSource
      */
@@ -112,6 +112,12 @@ export interface OAuthSource {
     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 OAuthSource
      */
@@ -129,7 +135,8 @@ export interface OAuthSource {
      */
     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 OAuthSource
      */
@@ -171,7 +178,7 @@ export interface OAuthSource {
      */
     consumerKey: string;
     /**
-     * 
+     * Get OAuth Callback URL
      * @type {string}
      * @memberof OAuthSource
      */

package/src/models/OAuthSourceRequest.ts

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

package/src/models/Outpost.ts

@@ -81,7 +81,7 @@ export interface Outpost {
      */
     serviceConnectionObj: OutpostServiceConnectionObj;
     /**
-     * 
+     * Get Token identifier
      * @type {string}
      * @memberof Outpost
      */

package/src/models/OutpostServiceConnectionObj.ts

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

package/src/models/OutpostTypeEnum.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `proxy` - Proxy
+ * * `ldap` - Ldap
  * @export
  */
 export const OutpostTypeEnum = {

package/src/models/PaginatedSCIMMappingList.ts

@@ -0,0 +1,77 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    PaginatedApplicationListPagination,
+    PaginatedApplicationListPaginationFromJSON,
+    PaginatedApplicationListPaginationFromJSONTyped,
+    PaginatedApplicationListPaginationToJSON,
+} from './PaginatedApplicationListPagination';
+import {
+    SCIMMapping,
+    SCIMMappingFromJSON,
+    SCIMMappingFromJSONTyped,
+    SCIMMappingToJSON,
+} from './SCIMMapping';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedSCIMMappingList
+ */
+export interface PaginatedSCIMMappingList {
+    /**
+     * 
+     * @type {PaginatedApplicationListPagination}
+     * @memberof PaginatedSCIMMappingList
+     */
+    pagination: PaginatedApplicationListPagination;
+    /**
+     * 
+     * @type {Array<SCIMMapping>}
+     * @memberof PaginatedSCIMMappingList
+     */
+    results: Array<SCIMMapping>;
+}
+
+export function PaginatedSCIMMappingListFromJSON(json: any): PaginatedSCIMMappingList {
+    return PaginatedSCIMMappingListFromJSONTyped(json, false);
+}
+
+export function PaginatedSCIMMappingListFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedSCIMMappingList {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pagination': PaginatedApplicationListPaginationFromJSON(json['pagination']),
+        'results': ((json['results'] as Array<any>).map(SCIMMappingFromJSON)),
+    };
+}
+
+export function PaginatedSCIMMappingListToJSON(value?: PaginatedSCIMMappingList | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'pagination': PaginatedApplicationListPaginationToJSON(value.pagination),
+        'results': ((value.results as Array<any>).map(SCIMMappingToJSON)),
+    };
+}
+