@goauthentik/api 2024.2.2-1713180481 → 2024.2.2-1713183841

package/src/models/SCIMSource.ts

@@ -0,0 +1,176 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.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 type { Token } from './Token';
+import {
+    TokenFromJSON,
+    TokenFromJSONTyped,
+    TokenToJSON,
+} from './Token';
+import type { UserMatchingModeEnum } from './UserMatchingModeEnum';
+import {
+    UserMatchingModeEnumFromJSON,
+    UserMatchingModeEnumFromJSONTyped,
+    UserMatchingModeEnumToJSON,
+} from './UserMatchingModeEnum';
+
+/**
+ * SCIMSource Serializer
+ * @export
+ * @interface SCIMSource
+ */
+export interface SCIMSource {
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    readonly pk: string;
+    /**
+     * Source's display Name.
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    name: string;
+    /**
+     * Internal source name, used in URLs.
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    slug: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SCIMSource
+     */
+    enabled?: boolean;
+    /**
+     * Get object component so that we know how to edit the object
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    readonly component: string;
+    /**
+     * Return object's verbose_name
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    readonly verboseName: string;
+    /**
+     * Return object's plural verbose_name
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    readonly verboseNamePlural: string;
+    /**
+     * Return internal model name
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    readonly metaModelName: string;
+    /**
+     * 
+     * @type {UserMatchingModeEnum}
+     * @memberof SCIMSource
+     */
+    userMatchingMode?: UserMatchingModeEnum;
+    /**
+     * Objects that are managed by authentik. These objects are created and updated automatically. This 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 SCIMSource
+     */
+    readonly managed: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    userPathTemplate?: string;
+    /**
+     * Get Root URL
+     * @type {string}
+     * @memberof SCIMSource
+     */
+    readonly rootUrl: string;
+    /**
+     * 
+     * @type {Token}
+     * @memberof SCIMSource
+     */
+    readonly tokenObj: Token;
+}
+
+/**
+ * Check if a given object implements the SCIMSource interface.
+ */
+export function instanceOfSCIMSource(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "pk" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "slug" in value;
+    isInstance = isInstance && "component" in value;
+    isInstance = isInstance && "verboseName" in value;
+    isInstance = isInstance && "verboseNamePlural" in value;
+    isInstance = isInstance && "metaModelName" in value;
+    isInstance = isInstance && "managed" in value;
+    isInstance = isInstance && "rootUrl" in value;
+    isInstance = isInstance && "tokenObj" in value;
+
+    return isInstance;
+}
+
+export function SCIMSourceFromJSON(json: any): SCIMSource {
+    return SCIMSourceFromJSONTyped(json, false);
+}
+
+export function SCIMSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMSource {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pk': json['pk'],
+        'name': json['name'],
+        'slug': json['slug'],
+        'enabled': !exists(json, 'enabled') ? undefined : json['enabled'],
+        'component': json['component'],
+        'verboseName': json['verbose_name'],
+        'verboseNamePlural': json['verbose_name_plural'],
+        'metaModelName': json['meta_model_name'],
+        'userMatchingMode': !exists(json, 'user_matching_mode') ? undefined : UserMatchingModeEnumFromJSON(json['user_matching_mode']),
+        'managed': json['managed'],
+        'userPathTemplate': !exists(json, 'user_path_template') ? undefined : json['user_path_template'],
+        'rootUrl': json['root_url'],
+        'tokenObj': TokenFromJSON(json['token_obj']),
+    };
+}
+
+export function SCIMSourceToJSON(value?: SCIMSource | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'slug': value.slug,
+        'enabled': value.enabled,
+        'user_matching_mode': UserMatchingModeEnumToJSON(value.userMatchingMode),
+        'user_path_template': value.userPathTemplate,
+    };
+}
+

package/src/models/SCIMSourceGroup.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.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 type { UserGroup } from './UserGroup';
+import {
+    UserGroupFromJSON,
+    UserGroupFromJSONTyped,
+    UserGroupToJSON,
+} from './UserGroup';
+
+/**
+ * SCIMSourceGroup Serializer
+ * @export
+ * @interface SCIMSourceGroup
+ */
+export interface SCIMSourceGroup {
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceGroup
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceGroup
+     */
+    group: string;
+    /**
+     * 
+     * @type {UserGroup}
+     * @memberof SCIMSourceGroup
+     */
+    readonly groupObj: UserGroup;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceGroup
+     */
+    source: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof SCIMSourceGroup
+     */
+    attributes?: any | null;
+}
+
+/**
+ * Check if a given object implements the SCIMSourceGroup interface.
+ */
+export function instanceOfSCIMSourceGroup(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "group" in value;
+    isInstance = isInstance && "groupObj" in value;
+    isInstance = isInstance && "source" in value;
+
+    return isInstance;
+}
+
+export function SCIMSourceGroupFromJSON(json: any): SCIMSourceGroup {
+    return SCIMSourceGroupFromJSONTyped(json, false);
+}
+
+export function SCIMSourceGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMSourceGroup {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'group': json['group'],
+        'groupObj': UserGroupFromJSON(json['group_obj']),
+        'source': json['source'],
+        'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+    };
+}
+
+export function SCIMSourceGroupToJSON(value?: SCIMSourceGroup | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'group': value.group,
+        'source': value.source,
+        'attributes': value.attributes,
+    };
+}
+

package/src/models/SCIMSourceGroupRequest.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.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';
+/**
+ * SCIMSourceGroup Serializer
+ * @export
+ * @interface SCIMSourceGroupRequest
+ */
+export interface SCIMSourceGroupRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceGroupRequest
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceGroupRequest
+     */
+    group: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceGroupRequest
+     */
+    source: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof SCIMSourceGroupRequest
+     */
+    attributes?: any | null;
+}
+
+/**
+ * Check if a given object implements the SCIMSourceGroupRequest interface.
+ */
+export function instanceOfSCIMSourceGroupRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "group" in value;
+    isInstance = isInstance && "source" in value;
+
+    return isInstance;
+}
+
+export function SCIMSourceGroupRequestFromJSON(json: any): SCIMSourceGroupRequest {
+    return SCIMSourceGroupRequestFromJSONTyped(json, false);
+}
+
+export function SCIMSourceGroupRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMSourceGroupRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'group': json['group'],
+        'source': json['source'],
+        'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+    };
+}
+
+export function SCIMSourceGroupRequestToJSON(value?: SCIMSourceGroupRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'group': value.group,
+        'source': value.source,
+        'attributes': value.attributes,
+    };
+}
+

package/src/models/SCIMSourceRequest.ts

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.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 type { UserMatchingModeEnum } from './UserMatchingModeEnum';
+import {
+    UserMatchingModeEnumFromJSON,
+    UserMatchingModeEnumFromJSONTyped,
+    UserMatchingModeEnumToJSON,
+} from './UserMatchingModeEnum';
+
+/**
+ * SCIMSource Serializer
+ * @export
+ * @interface SCIMSourceRequest
+ */
+export interface SCIMSourceRequest {
+    /**
+     * Source's display Name.
+     * @type {string}
+     * @memberof SCIMSourceRequest
+     */
+    name: string;
+    /**
+     * Internal source name, used in URLs.
+     * @type {string}
+     * @memberof SCIMSourceRequest
+     */
+    slug: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SCIMSourceRequest
+     */
+    enabled?: boolean;
+    /**
+     * 
+     * @type {UserMatchingModeEnum}
+     * @memberof SCIMSourceRequest
+     */
+    userMatchingMode?: UserMatchingModeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceRequest
+     */
+    userPathTemplate?: string;
+}
+
+/**
+ * Check if a given object implements the SCIMSourceRequest interface.
+ */
+export function instanceOfSCIMSourceRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "slug" in value;
+
+    return isInstance;
+}
+
+export function SCIMSourceRequestFromJSON(json: any): SCIMSourceRequest {
+    return SCIMSourceRequestFromJSONTyped(json, false);
+}
+
+export function SCIMSourceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMSourceRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'slug': json['slug'],
+        'enabled': !exists(json, 'enabled') ? undefined : json['enabled'],
+        'userMatchingMode': !exists(json, 'user_matching_mode') ? undefined : UserMatchingModeEnumFromJSON(json['user_matching_mode']),
+        'userPathTemplate': !exists(json, 'user_path_template') ? undefined : json['user_path_template'],
+    };
+}
+
+export function SCIMSourceRequestToJSON(value?: SCIMSourceRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'slug': value.slug,
+        'enabled': value.enabled,
+        'user_matching_mode': UserMatchingModeEnumToJSON(value.userMatchingMode),
+        'user_path_template': value.userPathTemplate,
+    };
+}
+

package/src/models/SCIMSourceUser.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.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 type { GroupMember } from './GroupMember';
+import {
+    GroupMemberFromJSON,
+    GroupMemberFromJSONTyped,
+    GroupMemberToJSON,
+} from './GroupMember';
+
+/**
+ * SCIMSourceUser Serializer
+ * @export
+ * @interface SCIMSourceUser
+ */
+export interface SCIMSourceUser {
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceUser
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SCIMSourceUser
+     */
+    user: number;
+    /**
+     * 
+     * @type {GroupMember}
+     * @memberof SCIMSourceUser
+     */
+    readonly userObj: GroupMember;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceUser
+     */
+    source: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof SCIMSourceUser
+     */
+    attributes?: any | null;
+}
+
+/**
+ * Check if a given object implements the SCIMSourceUser interface.
+ */
+export function instanceOfSCIMSourceUser(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "user" in value;
+    isInstance = isInstance && "userObj" in value;
+    isInstance = isInstance && "source" in value;
+
+    return isInstance;
+}
+
+export function SCIMSourceUserFromJSON(json: any): SCIMSourceUser {
+    return SCIMSourceUserFromJSONTyped(json, false);
+}
+
+export function SCIMSourceUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMSourceUser {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'user': json['user'],
+        'userObj': GroupMemberFromJSON(json['user_obj']),
+        'source': json['source'],
+        'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+    };
+}
+
+export function SCIMSourceUserToJSON(value?: SCIMSourceUser | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'user': value.user,
+        'source': value.source,
+        'attributes': value.attributes,
+    };
+}
+

package/src/models/SCIMSourceUserRequest.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.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';
+/**
+ * SCIMSourceUser Serializer
+ * @export
+ * @interface SCIMSourceUserRequest
+ */
+export interface SCIMSourceUserRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceUserRequest
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SCIMSourceUserRequest
+     */
+    user: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SCIMSourceUserRequest
+     */
+    source: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof SCIMSourceUserRequest
+     */
+    attributes?: any | null;
+}
+
+/**
+ * Check if a given object implements the SCIMSourceUserRequest interface.
+ */
+export function instanceOfSCIMSourceUserRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "user" in value;
+    isInstance = isInstance && "source" in value;
+
+    return isInstance;
+}
+
+export function SCIMSourceUserRequestFromJSON(json: any): SCIMSourceUserRequest {
+    return SCIMSourceUserRequestFromJSONTyped(json, false);
+}
+
+export function SCIMSourceUserRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SCIMSourceUserRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'user': json['user'],
+        'source': json['source'],
+        'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+    };
+}
+
+export function SCIMSourceUserRequestToJSON(value?: SCIMSourceUserRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'user': value.user,
+        'source': value.source,
+        'attributes': value.attributes,
+    };
+}
+

package/src/models/index.ts

@@ -283,6 +283,9 @@ export * from './PaginatedSAMLProviderList';
 export * from './PaginatedSAMLSourceList';
 export * from './PaginatedSCIMMappingList';
 export * from './PaginatedSCIMProviderList';
+export * from './PaginatedSCIMSourceGroupList';
+export * from './PaginatedSCIMSourceList';
+export * from './PaginatedSCIMSourceUserList';
 export * from './PaginatedSMSDeviceList';
 export * from './PaginatedScopeMappingList';
 export * from './PaginatedServiceConnectionList';
@@ -378,6 +381,9 @@ export * from './PatchedSAMLProviderRequest';
 export * from './PatchedSAMLSourceRequest';
 export * from './PatchedSCIMMappingRequest';
 export * from './PatchedSCIMProviderRequest';
+export * from './PatchedSCIMSourceGroupRequest';
+export * from './PatchedSCIMSourceRequest';
+export * from './PatchedSCIMSourceUserRequest';
 export * from './PatchedSMSDeviceRequest';
 export * from './PatchedScopeMappingRequest';
 export * from './PatchedSettingsRequest';
@@ -457,6 +463,12 @@ export * from './SCIMMapping';
 export * from './SCIMMappingRequest';
 export * from './SCIMProvider';
 export * from './SCIMProviderRequest';
+export * from './SCIMSource';
+export * from './SCIMSourceGroup';
+export * from './SCIMSourceGroupRequest';
+export * from './SCIMSourceRequest';
+export * from './SCIMSourceUser';
+export * from './SCIMSourceUserRequest';
 export * from './SCIMSyncStatus';
 export * from './SMSDevice';
 export * from './SMSDeviceRequest';