@goauthentik/api 2024.6.3-1723921843 → 2024.6.3-1724414734

package/src/apis/EnterpriseApi.ts

@@ -74,6 +74,10 @@ export interface EnterpriseLicenseRetrieveRequest {
     licenseUuid: string;
 }
 
+export interface EnterpriseLicenseSummaryRetrieveRequest {
+    cached?: boolean;
+}
+
 export interface EnterpriseLicenseUpdateRequest {
     licenseUuid: string;
     licenseRequest: LicenseRequest;
@@ -203,7 +207,7 @@ export class EnterpriseApi extends runtime.BaseAPI {
     /**
      * Get install_id
      */
-    async enterpriseLicenseGetInstallIdRetrieveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstallID>> {
+    async enterpriseLicenseInstallIdRetrieveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstallID>> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -217,7 +221,7 @@ export class EnterpriseApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/enterprise/license/get_install_id/`,
+            path: `/enterprise/license/install_id/`,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -229,8 +233,8 @@ export class EnterpriseApi extends runtime.BaseAPI {
     /**
      * Get install_id
      */
-    async enterpriseLicenseGetInstallIdRetrieve(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstallID> {
-        const response = await this.enterpriseLicenseGetInstallIdRetrieveRaw(initOverrides);
+    async enterpriseLicenseInstallIdRetrieve(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstallID> {
+        const response = await this.enterpriseLicenseInstallIdRetrieveRaw(initOverrides);
         return await response.value();
     }
 
@@ -370,9 +374,13 @@ export class EnterpriseApi extends runtime.BaseAPI {
     /**
      * Get the total license status
      */
-    async enterpriseLicenseSummaryRetrieveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LicenseSummary>> {
+    async enterpriseLicenseSummaryRetrieveRaw(requestParameters: EnterpriseLicenseSummaryRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LicenseSummary>> {
         const queryParameters: any = {};
 
+        if (requestParameters.cached !== undefined) {
+            queryParameters['cached'] = requestParameters.cached;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -396,8 +404,8 @@ export class EnterpriseApi extends runtime.BaseAPI {
     /**
      * Get the total license status
      */
-    async enterpriseLicenseSummaryRetrieve(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LicenseSummary> {
-        const response = await this.enterpriseLicenseSummaryRetrieveRaw(initOverrides);
+    async enterpriseLicenseSummaryRetrieve(requestParameters: EnterpriseLicenseSummaryRetrieveRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LicenseSummary> {
+        const response = await this.enterpriseLicenseSummaryRetrieveRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

package/src/apis/ProvidersApi.ts

@@ -75,6 +75,8 @@ import type {
   SCIMProviderRequest,
   SCIMProviderUser,
   SCIMProviderUserRequest,
+  SyncObjectRequest,
+  SyncObjectResult,
   SyncStatus,
   TypeCreate,
   UsedBy,
@@ -201,6 +203,10 @@ import {
     SCIMProviderUserToJSON,
     SCIMProviderUserRequestFromJSON,
     SCIMProviderUserRequestToJSON,
+    SyncObjectRequestFromJSON,
+    SyncObjectRequestToJSON,
+    SyncObjectResultFromJSON,
+    SyncObjectResultToJSON,
     SyncStatusFromJSON,
     SyncStatusToJSON,
     TypeCreateFromJSON,
@@ -286,6 +292,11 @@ export interface ProvidersGoogleWorkspaceRetrieveRequest {
     id: number;
 }
 
+export interface ProvidersGoogleWorkspaceSyncObjectCreateRequest {
+    id: number;
+    syncObjectRequest: SyncObjectRequest;
+}
+
 export interface ProvidersGoogleWorkspaceSyncStatusRetrieveRequest {
     id: number;
 }
@@ -420,6 +431,11 @@ export interface ProvidersMicrosoftEntraRetrieveRequest {
     id: number;
 }
 
+export interface ProvidersMicrosoftEntraSyncObjectCreateRequest {
+    id: number;
+    syncObjectRequest: SyncObjectRequest;
+}
+
 export interface ProvidersMicrosoftEntraSyncStatusRetrieveRequest {
     id: number;
 }
@@ -762,6 +778,11 @@ export interface ProvidersScimRetrieveRequest {
     id: number;
 }
 
+export interface ProvidersScimSyncObjectCreateRequest {
+    id: number;
+    syncObjectRequest: SyncObjectRequest;
+}
+
 export interface ProvidersScimSyncStatusRetrieveRequest {
     id: number;
 }
@@ -1450,6 +1471,51 @@ export class ProvidersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Sync/Re-sync a single user/group object
+     */
+    async providersGoogleWorkspaceSyncObjectCreateRaw(requestParameters: ProvidersGoogleWorkspaceSyncObjectCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyncObjectResult>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersGoogleWorkspaceSyncObjectCreate.');
+        }
+
+        if (requestParameters.syncObjectRequest === null || requestParameters.syncObjectRequest === undefined) {
+            throw new runtime.RequiredError('syncObjectRequest','Required parameter requestParameters.syncObjectRequest was null or undefined when calling providersGoogleWorkspaceSyncObjectCreate.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("authentik", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/providers/google_workspace/{id}/sync/object/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SyncObjectRequestToJSON(requestParameters.syncObjectRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SyncObjectResultFromJSON(jsonValue));
+    }
+
+    /**
+     * Sync/Re-sync a single user/group object
+     */
+    async providersGoogleWorkspaceSyncObjectCreate(requestParameters: ProvidersGoogleWorkspaceSyncObjectCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyncObjectResult> {
+        const response = await this.providersGoogleWorkspaceSyncObjectCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get provider\'s sync status
      */
@@ -2548,6 +2614,51 @@ export class ProvidersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Sync/Re-sync a single user/group object
+     */
+    async providersMicrosoftEntraSyncObjectCreateRaw(requestParameters: ProvidersMicrosoftEntraSyncObjectCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyncObjectResult>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersMicrosoftEntraSyncObjectCreate.');
+        }
+
+        if (requestParameters.syncObjectRequest === null || requestParameters.syncObjectRequest === undefined) {
+            throw new runtime.RequiredError('syncObjectRequest','Required parameter requestParameters.syncObjectRequest was null or undefined when calling providersMicrosoftEntraSyncObjectCreate.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("authentik", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/providers/microsoft_entra/{id}/sync/object/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SyncObjectRequestToJSON(requestParameters.syncObjectRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SyncObjectResultFromJSON(jsonValue));
+    }
+
+    /**
+     * Sync/Re-sync a single user/group object
+     */
+    async providersMicrosoftEntraSyncObjectCreate(requestParameters: ProvidersMicrosoftEntraSyncObjectCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyncObjectResult> {
+        const response = await this.providersMicrosoftEntraSyncObjectCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get provider\'s sync status
      */
@@ -5248,6 +5359,51 @@ export class ProvidersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Sync/Re-sync a single user/group object
+     */
+    async providersScimSyncObjectCreateRaw(requestParameters: ProvidersScimSyncObjectCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyncObjectResult>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersScimSyncObjectCreate.');
+        }
+
+        if (requestParameters.syncObjectRequest === null || requestParameters.syncObjectRequest === undefined) {
+            throw new runtime.RequiredError('syncObjectRequest','Required parameter requestParameters.syncObjectRequest was null or undefined when calling providersScimSyncObjectCreate.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("authentik", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/providers/scim/{id}/sync/object/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SyncObjectRequestToJSON(requestParameters.syncObjectRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SyncObjectResultFromJSON(jsonValue));
+    }
+
+    /**
+     * Sync/Re-sync a single user/group object
+     */
+    async providersScimSyncObjectCreate(requestParameters: ProvidersScimSyncObjectCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyncObjectResult> {
+        const response = await this.providersScimSyncObjectCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get provider\'s sync status
      */

package/src/models/SyncObjectModelEnum.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.6.3
+ * 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const SyncObjectModelEnum = {
+    User: 'authentik.core.models.User',
+    Group: 'authentik.core.models.Group',
+    UnknownDefaultOpenApi: '11184809'
+} as const;
+export type SyncObjectModelEnum = typeof SyncObjectModelEnum[keyof typeof SyncObjectModelEnum];
+
+
+export function SyncObjectModelEnumFromJSON(json: any): SyncObjectModelEnum {
+    return SyncObjectModelEnumFromJSONTyped(json, false);
+}
+
+export function SyncObjectModelEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncObjectModelEnum {
+    return json as SyncObjectModelEnum;
+}
+
+export function SyncObjectModelEnumToJSON(value?: SyncObjectModelEnum | null): any {
+    return value as any;
+}
+

package/src/models/SyncObjectRequest.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.6.3
+ * 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 { SyncObjectModelEnum } from './SyncObjectModelEnum';
+import {
+    SyncObjectModelEnumFromJSON,
+    SyncObjectModelEnumFromJSONTyped,
+    SyncObjectModelEnumToJSON,
+} from './SyncObjectModelEnum';
+
+/**
+ * Sync object serializer
+ * @export
+ * @interface SyncObjectRequest
+ */
+export interface SyncObjectRequest {
+    /**
+     * 
+     * @type {SyncObjectModelEnum}
+     * @memberof SyncObjectRequest
+     */
+    syncObjectModel: SyncObjectModelEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SyncObjectRequest
+     */
+    syncObjectId: string;
+}
+
+/**
+ * Check if a given object implements the SyncObjectRequest interface.
+ */
+export function instanceOfSyncObjectRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "syncObjectModel" in value;
+    isInstance = isInstance && "syncObjectId" in value;
+
+    return isInstance;
+}
+
+export function SyncObjectRequestFromJSON(json: any): SyncObjectRequest {
+    return SyncObjectRequestFromJSONTyped(json, false);
+}
+
+export function SyncObjectRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncObjectRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'syncObjectModel': SyncObjectModelEnumFromJSON(json['sync_object_model']),
+        'syncObjectId': json['sync_object_id'],
+    };
+}
+
+export function SyncObjectRequestToJSON(value?: SyncObjectRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'sync_object_model': SyncObjectModelEnumToJSON(value.syncObjectModel),
+        'sync_object_id': value.syncObjectId,
+    };
+}
+

package/src/models/SyncObjectResult.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.6.3
+ * 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 { LogEvent } from './LogEvent';
+import {
+    LogEventFromJSON,
+    LogEventFromJSONTyped,
+    LogEventToJSON,
+} from './LogEvent';
+
+/**
+ * Result of a single object sync
+ * @export
+ * @interface SyncObjectResult
+ */
+export interface SyncObjectResult {
+    /**
+     * 
+     * @type {Array<LogEvent>}
+     * @memberof SyncObjectResult
+     */
+    readonly messages: Array<LogEvent>;
+}
+
+/**
+ * Check if a given object implements the SyncObjectResult interface.
+ */
+export function instanceOfSyncObjectResult(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "messages" in value;
+
+    return isInstance;
+}
+
+export function SyncObjectResultFromJSON(json: any): SyncObjectResult {
+    return SyncObjectResultFromJSONTyped(json, false);
+}
+
+export function SyncObjectResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyncObjectResult {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'messages': ((json['messages'] as Array<any>).map(LogEventFromJSON)),
+    };
+}
+
+export function SyncObjectResultToJSON(value?: SyncObjectResult | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+    };
+}
+

package/src/models/index.ts

@@ -574,6 +574,9 @@ export * from './StaticDeviceRequest';
 export * from './StaticDeviceToken';
 export * from './StaticDeviceTokenRequest';
 export * from './SubModeEnum';
+export * from './SyncObjectModelEnum';
+export * from './SyncObjectRequest';
+export * from './SyncObjectResult';
 export * from './SyncStatus';
 export * from './SystemInfo';
 export * from './SystemInfoRuntime';