@goauthentik/api 2025.2.4-1744640358 → 2025.2.4-1744646168

package/src/apis/RbacApi.ts

@@ -20,14 +20,18 @@ import type {
   ExtraUserObjectPermission,
   ExtraUserObjectPermissionRequest,
   GenericError,
+  InitialPermissions,
+  InitialPermissionsRequest,
   PaginatedExtraRoleObjectPermissionList,
   PaginatedExtraUserObjectPermissionList,
+  PaginatedInitialPermissionsList,
   PaginatedPermissionList,
   PaginatedRoleAssignedObjectPermissionList,
   PaginatedRoleList,
   PaginatedUserAssignedObjectPermissionList,
   PatchedExtraRoleObjectPermissionRequest,
   PatchedExtraUserObjectPermissionRequest,
+  PatchedInitialPermissionsRequest,
   PatchedPermissionAssignRequest,
   PatchedRoleRequest,
   Permission,
@@ -49,10 +53,16 @@ import {
     ExtraUserObjectPermissionRequestToJSON,
     GenericErrorFromJSON,
     GenericErrorToJSON,
+    InitialPermissionsFromJSON,
+    InitialPermissionsToJSON,
+    InitialPermissionsRequestFromJSON,
+    InitialPermissionsRequestToJSON,
     PaginatedExtraRoleObjectPermissionListFromJSON,
     PaginatedExtraRoleObjectPermissionListToJSON,
     PaginatedExtraUserObjectPermissionListFromJSON,
     PaginatedExtraUserObjectPermissionListToJSON,
+    PaginatedInitialPermissionsListFromJSON,
+    PaginatedInitialPermissionsListToJSON,
     PaginatedPermissionListFromJSON,
     PaginatedPermissionListToJSON,
     PaginatedRoleAssignedObjectPermissionListFromJSON,
@@ -65,6 +75,8 @@ import {
     PatchedExtraRoleObjectPermissionRequestToJSON,
     PatchedExtraUserObjectPermissionRequestFromJSON,
     PatchedExtraUserObjectPermissionRequestToJSON,
+    PatchedInitialPermissionsRequestFromJSON,
+    PatchedInitialPermissionsRequestToJSON,
     PatchedPermissionAssignRequestFromJSON,
     PatchedPermissionAssignRequestToJSON,
     PatchedRoleRequestFromJSON,
@@ -85,6 +97,40 @@ import {
     ValidationErrorToJSON,
 } from '../models/index';
 
+export interface RbacInitialPermissionsCreateRequest {
+    initialPermissionsRequest: InitialPermissionsRequest;
+}
+
+export interface RbacInitialPermissionsDestroyRequest {
+    id: number;
+}
+
+export interface RbacInitialPermissionsListRequest {
+    name?: string;
+    ordering?: string;
+    page?: number;
+    pageSize?: number;
+    search?: string;
+}
+
+export interface RbacInitialPermissionsPartialUpdateRequest {
+    id: number;
+    patchedInitialPermissionsRequest?: PatchedInitialPermissionsRequest;
+}
+
+export interface RbacInitialPermissionsRetrieveRequest {
+    id: number;
+}
+
+export interface RbacInitialPermissionsUpdateRequest {
+    id: number;
+    initialPermissionsRequest: InitialPermissionsRequest;
+}
+
+export interface RbacInitialPermissionsUsedByListRequest {
+    id: number;
+}
+
 export interface RbacPermissionsAssignedByRolesAssignRequest {
     uuid: string;
     permissionAssignRequest: PermissionAssignRequest;
@@ -230,6 +276,321 @@ export interface RbacRolesUsedByListRequest {
  */
 export class RbacApi extends runtime.BaseAPI {
 
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsCreateRaw(requestParameters: RbacInitialPermissionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InitialPermissions>> {
+        if (requestParameters['initialPermissionsRequest'] == null) {
+            throw new runtime.RequiredError(
+                'initialPermissionsRequest',
+                'Required parameter "initialPermissionsRequest" was null or undefined when calling rbacInitialPermissionsCreate().'
+            );
+        }
+
+        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: `/rbac/initial_permissions/`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: InitialPermissionsRequestToJSON(requestParameters['initialPermissionsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InitialPermissionsFromJSON(jsonValue));
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsCreate(requestParameters: RbacInitialPermissionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InitialPermissions> {
+        const response = await this.rbacInitialPermissionsCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsDestroyRaw(requestParameters: RbacInitialPermissionsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling rbacInitialPermissionsDestroy().'
+            );
+        }
+
+        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: `/rbac/initial_permissions/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsDestroy(requestParameters: RbacInitialPermissionsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.rbacInitialPermissionsDestroyRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsListRaw(requestParameters: RbacInitialPermissionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedInitialPermissionsList>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['name'] != null) {
+            queryParameters['name'] = requestParameters['name'];
+        }
+
+        if (requestParameters['ordering'] != null) {
+            queryParameters['ordering'] = requestParameters['ordering'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['search'] != null) {
+            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: `/rbac/initial_permissions/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedInitialPermissionsListFromJSON(jsonValue));
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsList(requestParameters: RbacInitialPermissionsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedInitialPermissionsList> {
+        const response = await this.rbacInitialPermissionsListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsPartialUpdateRaw(requestParameters: RbacInitialPermissionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InitialPermissions>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling rbacInitialPermissionsPartialUpdate().'
+            );
+        }
+
+        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: `/rbac/initial_permissions/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PatchedInitialPermissionsRequestToJSON(requestParameters['patchedInitialPermissionsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InitialPermissionsFromJSON(jsonValue));
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsPartialUpdate(requestParameters: RbacInitialPermissionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InitialPermissions> {
+        const response = await this.rbacInitialPermissionsPartialUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsRetrieveRaw(requestParameters: RbacInitialPermissionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InitialPermissions>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling rbacInitialPermissionsRetrieve().'
+            );
+        }
+
+        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: `/rbac/initial_permissions/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InitialPermissionsFromJSON(jsonValue));
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsRetrieve(requestParameters: RbacInitialPermissionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InitialPermissions> {
+        const response = await this.rbacInitialPermissionsRetrieveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsUpdateRaw(requestParameters: RbacInitialPermissionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InitialPermissions>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling rbacInitialPermissionsUpdate().'
+            );
+        }
+
+        if (requestParameters['initialPermissionsRequest'] == null) {
+            throw new runtime.RequiredError(
+                'initialPermissionsRequest',
+                'Required parameter "initialPermissionsRequest" was null or undefined when calling rbacInitialPermissionsUpdate().'
+            );
+        }
+
+        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: `/rbac/initial_permissions/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: InitialPermissionsRequestToJSON(requestParameters['initialPermissionsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InitialPermissionsFromJSON(jsonValue));
+    }
+
+    /**
+     * InitialPermissions viewset
+     */
+    async rbacInitialPermissionsUpdate(requestParameters: RbacInitialPermissionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InitialPermissions> {
+        const response = await this.rbacInitialPermissionsUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get a list of all objects that use this object
+     */
+    async rbacInitialPermissionsUsedByListRaw(requestParameters: RbacInitialPermissionsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<UsedBy>>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling rbacInitialPermissionsUsedByList().'
+            );
+        }
+
+        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: `/rbac/initial_permissions/{id}/used_by/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+            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 rbacInitialPermissionsUsedByList(requestParameters: RbacInitialPermissionsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UsedBy>> {
+        const response = await this.rbacInitialPermissionsUsedByListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Assign permission(s) to role. When `object_pk` is set, the permissions are only assigned to the specific object, otherwise they are assigned globally.
      */
@@ -1485,6 +1846,7 @@ export const RbacPermissionsAssignedByRolesListModelEnum = {
     AuthentikProvidersScimScimmapping: 'authentik_providers_scim.scimmapping',
     AuthentikProvidersScimScimprovider: 'authentik_providers_scim.scimprovider',
     AuthentikProvidersSsfSsfprovider: 'authentik_providers_ssf.ssfprovider',
+    AuthentikRbacInitialpermissions: 'authentik_rbac.initialpermissions',
     AuthentikRbacRole: 'authentik_rbac.role',
     AuthentikSourcesKerberosGroupkerberossourceconnection: 'authentik_sources_kerberos.groupkerberossourceconnection',
     AuthentikSourcesKerberosKerberossource: 'authentik_sources_kerberos.kerberossource',
@@ -1593,6 +1955,7 @@ export const RbacPermissionsAssignedByUsersListModelEnum = {
     AuthentikProvidersScimScimmapping: 'authentik_providers_scim.scimmapping',
     AuthentikProvidersScimScimprovider: 'authentik_providers_scim.scimprovider',
     AuthentikProvidersSsfSsfprovider: 'authentik_providers_ssf.ssfprovider',
+    AuthentikRbacInitialpermissions: 'authentik_rbac.initialpermissions',
     AuthentikRbacRole: 'authentik_rbac.role',
     AuthentikSourcesKerberosGroupkerberossourceconnection: 'authentik_sources_kerberos.groupkerberossourceconnection',
     AuthentikSourcesKerberosKerberossource: 'authentik_sources_kerberos.kerberossource',

package/src/models/InitialPermissions.ts

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2025.2.4
+ * 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 { mapValues } from '../runtime';
+import type { Permission } from './Permission';
+import {
+    PermissionFromJSON,
+    PermissionFromJSONTyped,
+    PermissionToJSON,
+    PermissionToJSONTyped,
+} from './Permission';
+import type { InitialPermissionsModeEnum } from './InitialPermissionsModeEnum';
+import {
+    InitialPermissionsModeEnumFromJSON,
+    InitialPermissionsModeEnumFromJSONTyped,
+    InitialPermissionsModeEnumToJSON,
+    InitialPermissionsModeEnumToJSONTyped,
+} from './InitialPermissionsModeEnum';
+
+/**
+ * InitialPermissions serializer
+ * @export
+ * @interface InitialPermissions
+ */
+export interface InitialPermissions {
+    /**
+     * 
+     * @type {number}
+     * @memberof InitialPermissions
+     */
+    readonly pk: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof InitialPermissions
+     */
+    name: string;
+    /**
+     * 
+     * @type {InitialPermissionsModeEnum}
+     * @memberof InitialPermissions
+     */
+    mode: InitialPermissionsModeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof InitialPermissions
+     */
+    role: string;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof InitialPermissions
+     */
+    permissions?: Array<number>;
+    /**
+     * 
+     * @type {Array<Permission>}
+     * @memberof InitialPermissions
+     */
+    readonly permissionsObj: Array<Permission>;
+}
+
+
+
+/**
+ * Check if a given object implements the InitialPermissions interface.
+ */
+export function instanceOfInitialPermissions(value: object): value is InitialPermissions {
+    if (!('pk' in value) || value['pk'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('mode' in value) || value['mode'] === undefined) return false;
+    if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('permissionsObj' in value) || value['permissionsObj'] === undefined) return false;
+    return true;
+}
+
+export function InitialPermissionsFromJSON(json: any): InitialPermissions {
+    return InitialPermissionsFromJSONTyped(json, false);
+}
+
+export function InitialPermissionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): InitialPermissions {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pk': json['pk'],
+        'name': json['name'],
+        'mode': InitialPermissionsModeEnumFromJSON(json['mode']),
+        'role': json['role'],
+        'permissions': json['permissions'] == null ? undefined : json['permissions'],
+        'permissionsObj': ((json['permissions_obj'] as Array<any>).map(PermissionFromJSON)),
+    };
+}
+
+export function InitialPermissionsToJSON(json: any): InitialPermissions {
+    return InitialPermissionsToJSONTyped(json, false);
+}
+
+export function InitialPermissionsToJSONTyped(value?: Omit<InitialPermissions, 'pk'|'permissions_obj'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'mode': InitialPermissionsModeEnumToJSON(value['mode']),
+        'role': value['role'],
+        'permissions': value['permissions'],
+    };
+}
+

package/src/models/InitialPermissionsModeEnum.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2025.2.4
+ * 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 InitialPermissionsModeEnum = {
+    User: 'user',
+    Role: 'role',
+    UnknownDefaultOpenApi: '11184809'
+} as const;
+export type InitialPermissionsModeEnum = typeof InitialPermissionsModeEnum[keyof typeof InitialPermissionsModeEnum];
+
+
+export function instanceOfInitialPermissionsModeEnum(value: any): boolean {
+    for (const key in InitialPermissionsModeEnum) {
+        if (Object.prototype.hasOwnProperty.call(InitialPermissionsModeEnum, key)) {
+            if (InitialPermissionsModeEnum[key as keyof typeof InitialPermissionsModeEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function InitialPermissionsModeEnumFromJSON(json: any): InitialPermissionsModeEnum {
+    return InitialPermissionsModeEnumFromJSONTyped(json, false);
+}
+
+export function InitialPermissionsModeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): InitialPermissionsModeEnum {
+    return json as InitialPermissionsModeEnum;
+}
+
+export function InitialPermissionsModeEnumToJSON(value?: InitialPermissionsModeEnum | null): any {
+    return value as any;
+}
+
+export function InitialPermissionsModeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): InitialPermissionsModeEnum {
+    return value as InitialPermissionsModeEnum;
+}
+