@goauthentik/api 2024.10.5-1734524927 → 2024.10.5-1734528783

package/src/apis/CoreApi.ts

@@ -16,6 +16,8 @@
 import * as runtime from '../runtime';
 import type {
   Application,
+  ApplicationEntitlement,
+  ApplicationEntitlementRequest,
   ApplicationRequest,
   AuthenticatedSession,
   Brand,
@@ -28,6 +30,7 @@ import type {
   GroupRequest,
   ImpersonationRequest,
   Link,
+  PaginatedApplicationEntitlementList,
   PaginatedApplicationList,
   PaginatedAuthenticatedSessionList,
   PaginatedBrandList,
@@ -35,6 +38,7 @@ import type {
   PaginatedTokenList,
   PaginatedUserConsentList,
   PaginatedUserList,
+  PatchedApplicationEntitlementRequest,
   PatchedApplicationRequest,
   PatchedBrandRequest,
   PatchedGroupRequest,
@@ -63,6 +67,10 @@ import type {
 import {
     ApplicationFromJSON,
     ApplicationToJSON,
+    ApplicationEntitlementFromJSON,
+    ApplicationEntitlementToJSON,
+    ApplicationEntitlementRequestFromJSON,
+    ApplicationEntitlementRequestToJSON,
     ApplicationRequestFromJSON,
     ApplicationRequestToJSON,
     AuthenticatedSessionFromJSON,
@@ -87,6 +95,8 @@ import {
     ImpersonationRequestToJSON,
     LinkFromJSON,
     LinkToJSON,
+    PaginatedApplicationEntitlementListFromJSON,
+    PaginatedApplicationEntitlementListToJSON,
     PaginatedApplicationListFromJSON,
     PaginatedApplicationListToJSON,
     PaginatedAuthenticatedSessionListFromJSON,
@@ -101,6 +111,8 @@ import {
     PaginatedUserConsentListToJSON,
     PaginatedUserListFromJSON,
     PaginatedUserListToJSON,
+    PatchedApplicationEntitlementRequestFromJSON,
+    PatchedApplicationEntitlementRequestToJSON,
     PatchedApplicationRequestFromJSON,
     PatchedApplicationRequestToJSON,
     PatchedBrandRequestFromJSON,
@@ -151,6 +163,42 @@ import {
     ValidationErrorToJSON,
 } from '../models';
 
+export interface CoreApplicationEntitlementsCreateRequest {
+    applicationEntitlementRequest: ApplicationEntitlementRequest;
+}
+
+export interface CoreApplicationEntitlementsDestroyRequest {
+    pbmUuid: string;
+}
+
+export interface CoreApplicationEntitlementsListRequest {
+    app?: string;
+    name?: string;
+    ordering?: string;
+    page?: number;
+    pageSize?: number;
+    pbmUuid?: string;
+    search?: string;
+}
+
+export interface CoreApplicationEntitlementsPartialUpdateRequest {
+    pbmUuid: string;
+    patchedApplicationEntitlementRequest?: PatchedApplicationEntitlementRequest;
+}
+
+export interface CoreApplicationEntitlementsRetrieveRequest {
+    pbmUuid: string;
+}
+
+export interface CoreApplicationEntitlementsUpdateRequest {
+    pbmUuid: string;
+    applicationEntitlementRequest: ApplicationEntitlementRequest;
+}
+
+export interface CoreApplicationEntitlementsUsedByListRequest {
+    pbmUuid: string;
+}
+
 export interface CoreApplicationsCheckAccessRetrieveRequest {
     slug: string;
     forUser?: number;
@@ -487,6 +535,308 @@ export interface CoreUsersUsedByListRequest {
  */
 export class CoreApi extends runtime.BaseAPI {
 
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsCreateRaw(requestParameters: CoreApplicationEntitlementsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationEntitlement>> {
+        if (requestParameters.applicationEntitlementRequest === null || requestParameters.applicationEntitlementRequest === undefined) {
+            throw new runtime.RequiredError('applicationEntitlementRequest','Required parameter requestParameters.applicationEntitlementRequest was null or undefined when calling coreApplicationEntitlementsCreate.');
+        }
+
+        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: `/core/application_entitlements/`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ApplicationEntitlementRequestToJSON(requestParameters.applicationEntitlementRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApplicationEntitlementFromJSON(jsonValue));
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsCreate(requestParameters: CoreApplicationEntitlementsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationEntitlement> {
+        const response = await this.coreApplicationEntitlementsCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsDestroyRaw(requestParameters: CoreApplicationEntitlementsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.pbmUuid === null || requestParameters.pbmUuid === undefined) {
+            throw new runtime.RequiredError('pbmUuid','Required parameter requestParameters.pbmUuid was null or undefined when calling coreApplicationEntitlementsDestroy.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: `/core/application_entitlements/{pbm_uuid}/`.replace(`{${"pbm_uuid"}}`, encodeURIComponent(String(requestParameters.pbmUuid))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsDestroy(requestParameters: CoreApplicationEntitlementsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.coreApplicationEntitlementsDestroyRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsListRaw(requestParameters: CoreApplicationEntitlementsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedApplicationEntitlementList>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.app !== undefined) {
+            queryParameters['app'] = requestParameters.app;
+        }
+
+        if (requestParameters.name !== undefined) {
+            queryParameters['name'] = requestParameters.name;
+        }
+
+        if (requestParameters.ordering !== undefined) {
+            queryParameters['ordering'] = requestParameters.ordering;
+        }
+
+        if (requestParameters.page !== undefined) {
+            queryParameters['page'] = requestParameters.page;
+        }
+
+        if (requestParameters.pageSize !== undefined) {
+            queryParameters['page_size'] = requestParameters.pageSize;
+        }
+
+        if (requestParameters.pbmUuid !== undefined) {
+            queryParameters['pbm_uuid'] = requestParameters.pbmUuid;
+        }
+
+        if (requestParameters.search !== undefined) {
+            queryParameters['search'] = requestParameters.search;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: `/core/application_entitlements/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedApplicationEntitlementListFromJSON(jsonValue));
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsList(requestParameters: CoreApplicationEntitlementsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedApplicationEntitlementList> {
+        const response = await this.coreApplicationEntitlementsListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsPartialUpdateRaw(requestParameters: CoreApplicationEntitlementsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationEntitlement>> {
+        if (requestParameters.pbmUuid === null || requestParameters.pbmUuid === undefined) {
+            throw new runtime.RequiredError('pbmUuid','Required parameter requestParameters.pbmUuid was null or undefined when calling coreApplicationEntitlementsPartialUpdate.');
+        }
+
+        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: `/core/application_entitlements/{pbm_uuid}/`.replace(`{${"pbm_uuid"}}`, encodeURIComponent(String(requestParameters.pbmUuid))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PatchedApplicationEntitlementRequestToJSON(requestParameters.patchedApplicationEntitlementRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApplicationEntitlementFromJSON(jsonValue));
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsPartialUpdate(requestParameters: CoreApplicationEntitlementsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationEntitlement> {
+        const response = await this.coreApplicationEntitlementsPartialUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsRetrieveRaw(requestParameters: CoreApplicationEntitlementsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationEntitlement>> {
+        if (requestParameters.pbmUuid === null || requestParameters.pbmUuid === undefined) {
+            throw new runtime.RequiredError('pbmUuid','Required parameter requestParameters.pbmUuid was null or undefined when calling coreApplicationEntitlementsRetrieve.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: `/core/application_entitlements/{pbm_uuid}/`.replace(`{${"pbm_uuid"}}`, encodeURIComponent(String(requestParameters.pbmUuid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApplicationEntitlementFromJSON(jsonValue));
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsRetrieve(requestParameters: CoreApplicationEntitlementsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationEntitlement> {
+        const response = await this.coreApplicationEntitlementsRetrieveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsUpdateRaw(requestParameters: CoreApplicationEntitlementsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationEntitlement>> {
+        if (requestParameters.pbmUuid === null || requestParameters.pbmUuid === undefined) {
+            throw new runtime.RequiredError('pbmUuid','Required parameter requestParameters.pbmUuid was null or undefined when calling coreApplicationEntitlementsUpdate.');
+        }
+
+        if (requestParameters.applicationEntitlementRequest === null || requestParameters.applicationEntitlementRequest === undefined) {
+            throw new runtime.RequiredError('applicationEntitlementRequest','Required parameter requestParameters.applicationEntitlementRequest was null or undefined when calling coreApplicationEntitlementsUpdate.');
+        }
+
+        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: `/core/application_entitlements/{pbm_uuid}/`.replace(`{${"pbm_uuid"}}`, encodeURIComponent(String(requestParameters.pbmUuid))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ApplicationEntitlementRequestToJSON(requestParameters.applicationEntitlementRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApplicationEntitlementFromJSON(jsonValue));
+    }
+
+    /**
+     * ApplicationEntitlement Viewset
+     */
+    async coreApplicationEntitlementsUpdate(requestParameters: CoreApplicationEntitlementsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationEntitlement> {
+        const response = await this.coreApplicationEntitlementsUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get a list of all objects that use this object
+     */
+    async coreApplicationEntitlementsUsedByListRaw(requestParameters: CoreApplicationEntitlementsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<UsedBy>>> {
+        if (requestParameters.pbmUuid === null || requestParameters.pbmUuid === undefined) {
+            throw new runtime.RequiredError('pbmUuid','Required parameter requestParameters.pbmUuid was null or undefined when calling coreApplicationEntitlementsUsedByList.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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: `/core/application_entitlements/{pbm_uuid}/used_by/`.replace(`{${"pbm_uuid"}}`, encodeURIComponent(String(requestParameters.pbmUuid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(UsedByFromJSON));
+    }
+
+    /**
+     * Get a list of all objects that use this object
+     */
+    async coreApplicationEntitlementsUsedByList(requestParameters: CoreApplicationEntitlementsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UsedBy>> {
+        const response = await this.coreApplicationEntitlementsUsedByListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Check access to a single application by slug
      */

package/src/apis/RbacApi.ts

@@ -1365,6 +1365,7 @@ export const RbacPermissionsAssignedByRolesListModelEnum = {
     BlueprintsBlueprintinstance: 'authentik_blueprints.blueprintinstance',
     BrandsBrand: 'authentik_brands.brand',
     CoreApplication: 'authentik_core.application',
+    CoreApplicationentitlement: 'authentik_core.applicationentitlement',
     CoreGroup: 'authentik_core.group',
     CoreToken: 'authentik_core.token',
     CoreUser: 'authentik_core.user',
@@ -1467,6 +1468,7 @@ export const RbacPermissionsAssignedByUsersListModelEnum = {
     BlueprintsBlueprintinstance: 'authentik_blueprints.blueprintinstance',
     BrandsBrand: 'authentik_brands.brand',
     CoreApplication: 'authentik_core.application',
+    CoreApplicationentitlement: 'authentik_core.applicationentitlement',
     CoreGroup: 'authentik_core.group',
     CoreToken: 'authentik_core.token',
     CoreUser: 'authentik_core.user',

package/src/models/ApplicationEntitlement.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.10.5
+ * 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';
+/**
+ * ApplicationEntitlement Serializer
+ * @export
+ * @interface ApplicationEntitlement
+ */
+export interface ApplicationEntitlement {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApplicationEntitlement
+     */
+    readonly pbmUuid: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApplicationEntitlement
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApplicationEntitlement
+     */
+    app: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof ApplicationEntitlement
+     */
+    attributes?: any | null;
+}
+
+/**
+ * Check if a given object implements the ApplicationEntitlement interface.
+ */
+export function instanceOfApplicationEntitlement(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "pbmUuid" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "app" in value;
+
+    return isInstance;
+}
+
+export function ApplicationEntitlementFromJSON(json: any): ApplicationEntitlement {
+    return ApplicationEntitlementFromJSONTyped(json, false);
+}
+
+export function ApplicationEntitlementFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApplicationEntitlement {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pbmUuid': json['pbm_uuid'],
+        'name': json['name'],
+        'app': json['app'],
+        'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+    };
+}
+
+export function ApplicationEntitlementToJSON(value?: ApplicationEntitlement | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'app': value.app,
+        'attributes': value.attributes,
+    };
+}
+

package/src/models/ApplicationEntitlementRequest.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.10.5
+ * 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';
+/**
+ * ApplicationEntitlement Serializer
+ * @export
+ * @interface ApplicationEntitlementRequest
+ */
+export interface ApplicationEntitlementRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApplicationEntitlementRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApplicationEntitlementRequest
+     */
+    app: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof ApplicationEntitlementRequest
+     */
+    attributes?: any | null;
+}
+
+/**
+ * Check if a given object implements the ApplicationEntitlementRequest interface.
+ */
+export function instanceOfApplicationEntitlementRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "app" in value;
+
+    return isInstance;
+}
+
+export function ApplicationEntitlementRequestFromJSON(json: any): ApplicationEntitlementRequest {
+    return ApplicationEntitlementRequestFromJSONTyped(json, false);
+}
+
+export function ApplicationEntitlementRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApplicationEntitlementRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'app': json['app'],
+        'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+    };
+}
+
+export function ApplicationEntitlementRequestToJSON(value?: ApplicationEntitlementRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'app': value.app,
+        'attributes': value.attributes,
+    };
+}
+

package/src/models/IdentificationChallenge.ts

@@ -103,7 +103,7 @@ export interface IdentificationChallenge {
      * @type {CaptchaChallenge}
      * @memberof IdentificationChallenge
      */
-    captchaStage?: CaptchaChallenge;
+    captchaStage?: CaptchaChallenge | null;
     /**
      * 
      * @type {string}

package/src/models/ModelEnum.ts

@@ -97,6 +97,7 @@ export const ModelEnum = {
     CoreGroup: 'authentik_core.group',
     CoreUser: 'authentik_core.user',
     CoreApplication: 'authentik_core.application',
+    CoreApplicationentitlement: 'authentik_core.applicationentitlement',
     CoreToken: 'authentik_core.token',
     EnterpriseLicense: 'authentik_enterprise.license',
     ProvidersGoogleWorkspaceGoogleworkspaceprovider: 'authentik_providers_google_workspace.googleworkspaceprovider',