@goauthentik/api 2023.8.3-1696847703 → 2023.8.3-1697642041

package/dist/esm/models/PatchedGroupRequest.d.ts

@@ -47,6 +47,12 @@ export interface PatchedGroupRequest {
     attributes?: {
         [key: string]: any;
     };
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PatchedGroupRequest
+     */
+    roles?: Array<string>;
 }
 /**
  * Check if a given object implements the PatchedGroupRequest interface.

package/dist/esm/models/PatchedGroupRequest.js

@@ -32,6 +32,7 @@ export function PatchedGroupRequestFromJSONTyped(json, ignoreDiscriminator) {
         'parent': !exists(json, 'parent') ? undefined : json['parent'],
         'users': !exists(json, 'users') ? undefined : json['users'],
         'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+        'roles': !exists(json, 'roles') ? undefined : json['roles'],
     };
 }
 export function PatchedGroupRequestToJSON(value) {
@@ -47,5 +48,6 @@ export function PatchedGroupRequestToJSON(value) {
         'parent': value.parent,
         'users': value.users,
         'attributes': value.attributes,
+        'roles': value.roles,
     };
 }

package/dist/esm/models/PatchedPermissionAssignRequest.d.ts

@@ -0,0 +1,44 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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 type { ModelEnum } from './ModelEnum';
+/**
+ * Request to assign a new permission
+ * @export
+ * @interface PatchedPermissionAssignRequest
+ */
+export interface PatchedPermissionAssignRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PatchedPermissionAssignRequest
+     */
+    permissions?: Array<string>;
+    /**
+     *
+     * @type {ModelEnum}
+     * @memberof PatchedPermissionAssignRequest
+     */
+    model?: ModelEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchedPermissionAssignRequest
+     */
+    objectPk?: string;
+}
+/**
+ * Check if a given object implements the PatchedPermissionAssignRequest interface.
+ */
+export declare function instanceOfPatchedPermissionAssignRequest(value: object): boolean;
+export declare function PatchedPermissionAssignRequestFromJSON(json: any): PatchedPermissionAssignRequest;
+export declare function PatchedPermissionAssignRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedPermissionAssignRequest;
+export declare function PatchedPermissionAssignRequestToJSON(value?: PatchedPermissionAssignRequest | null): any;

package/dist/esm/models/PatchedPermissionAssignRequest.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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 } from '../runtime';
+import { ModelEnumFromJSON, ModelEnumToJSON, } from './ModelEnum';
+/**
+ * Check if a given object implements the PatchedPermissionAssignRequest interface.
+ */
+export function instanceOfPatchedPermissionAssignRequest(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function PatchedPermissionAssignRequestFromJSON(json) {
+    return PatchedPermissionAssignRequestFromJSONTyped(json, false);
+}
+export function PatchedPermissionAssignRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'permissions': !exists(json, 'permissions') ? undefined : json['permissions'],
+        'model': !exists(json, 'model') ? undefined : ModelEnumFromJSON(json['model']),
+        'objectPk': !exists(json, 'object_pk') ? undefined : json['object_pk'],
+    };
+}
+export function PatchedPermissionAssignRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'permissions': value.permissions,
+        'model': ModelEnumToJSON(value.model),
+        'object_pk': value.objectPk,
+    };
+}

package/dist/esm/models/PatchedRoleRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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.
+ */
+/**
+ * Role serializer
+ * @export
+ * @interface PatchedRoleRequest
+ */
+export interface PatchedRoleRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PatchedRoleRequest
+     */
+    name?: string;
+}
+/**
+ * Check if a given object implements the PatchedRoleRequest interface.
+ */
+export declare function instanceOfPatchedRoleRequest(value: object): boolean;
+export declare function PatchedRoleRequestFromJSON(json: any): PatchedRoleRequest;
+export declare function PatchedRoleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedRoleRequest;
+export declare function PatchedRoleRequestToJSON(value?: PatchedRoleRequest | null): any;

package/dist/esm/models/PatchedRoleRequest.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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 } from '../runtime';
+/**
+ * Check if a given object implements the PatchedRoleRequest interface.
+ */
+export function instanceOfPatchedRoleRequest(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function PatchedRoleRequestFromJSON(json) {
+    return PatchedRoleRequestFromJSONTyped(json, false);
+}
+export function PatchedRoleRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !exists(json, 'name') ? undefined : json['name'],
+    };
+}
+export function PatchedRoleRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+    };
+}

package/dist/esm/models/Permission.d.ts

@@ -10,11 +10,17 @@
  * Do not edit the class manually.
  */
 /**
- * Permission used for consent
+ * Global permission
  * @export
  * @interface Permission
  */
 export interface Permission {
+    /**
+     *
+     * @type {number}
+     * @memberof Permission
+     */
+    readonly id: number;
     /**
      *
      * @type {string}
@@ -26,7 +32,31 @@ export interface Permission {
      * @type {string}
      * @memberof Permission
      */
-    id: string;
+    codename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Permission
+     */
+    readonly model: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Permission
+     */
+    readonly appLabel: string;
+    /**
+     * Human-readable app label
+     * @type {string}
+     * @memberof Permission
+     */
+    readonly appLabelVerbose: string;
+    /**
+     * Human-readable model name
+     * @type {string}
+     * @memberof Permission
+     */
+    readonly modelVerbose: string;
 }
 /**
  * Check if a given object implements the Permission interface.

package/dist/esm/models/Permission.js

@@ -16,8 +16,13 @@
  */
 export function instanceOfPermission(value) {
     let isInstance = true;
-    isInstance = isInstance && "name" in value;
     isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "codename" in value;
+    isInstance = isInstance && "model" in value;
+    isInstance = isInstance && "appLabel" in value;
+    isInstance = isInstance && "appLabelVerbose" in value;
+    isInstance = isInstance && "modelVerbose" in value;
     return isInstance;
 }
 export function PermissionFromJSON(json) {
@@ -28,8 +33,13 @@ export function PermissionFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'name': json['name'],
         'id': json['id'],
+        'name': json['name'],
+        'codename': json['codename'],
+        'model': json['model'],
+        'appLabel': json['app_label'],
+        'appLabelVerbose': json['app_label_verbose'],
+        'modelVerbose': json['model_verbose'],
     };
 }
 export function PermissionToJSON(value) {
@@ -41,6 +51,6 @@ export function PermissionToJSON(value) {
     }
     return {
         'name': value.name,
-        'id': value.id,
+        'codename': value.codename,
     };
 }

package/dist/esm/models/PermissionAssignRequest.d.ts

@@ -0,0 +1,44 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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 type { ModelEnum } from './ModelEnum';
+/**
+ * Request to assign a new permission
+ * @export
+ * @interface PermissionAssignRequest
+ */
+export interface PermissionAssignRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PermissionAssignRequest
+     */
+    permissions: Array<string>;
+    /**
+     *
+     * @type {ModelEnum}
+     * @memberof PermissionAssignRequest
+     */
+    model?: ModelEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionAssignRequest
+     */
+    objectPk?: string;
+}
+/**
+ * Check if a given object implements the PermissionAssignRequest interface.
+ */
+export declare function instanceOfPermissionAssignRequest(value: object): boolean;
+export declare function PermissionAssignRequestFromJSON(json: any): PermissionAssignRequest;
+export declare function PermissionAssignRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PermissionAssignRequest;
+export declare function PermissionAssignRequestToJSON(value?: PermissionAssignRequest | null): any;

package/dist/esm/models/PermissionAssignRequest.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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 } from '../runtime';
+import { ModelEnumFromJSON, ModelEnumToJSON, } from './ModelEnum';
+/**
+ * Check if a given object implements the PermissionAssignRequest interface.
+ */
+export function instanceOfPermissionAssignRequest(value) {
+    let isInstance = true;
+    isInstance = isInstance && "permissions" in value;
+    return isInstance;
+}
+export function PermissionAssignRequestFromJSON(json) {
+    return PermissionAssignRequestFromJSONTyped(json, false);
+}
+export function PermissionAssignRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'permissions': json['permissions'],
+        'model': !exists(json, 'model') ? undefined : ModelEnumFromJSON(json['model']),
+        'objectPk': !exists(json, 'object_pk') ? undefined : json['object_pk'],
+    };
+}
+export function PermissionAssignRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'permissions': value.permissions,
+        'model': ModelEnumToJSON(value.model),
+        'object_pk': value.objectPk,
+    };
+}

package/dist/esm/models/Role.d.ts

@@ -0,0 +1,37 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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.
+ */
+/**
+ * Role serializer
+ * @export
+ * @interface Role
+ */
+export interface Role {
+    /**
+     *
+     * @type {string}
+     * @memberof Role
+     */
+    readonly pk: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Role
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the Role interface.
+ */
+export declare function instanceOfRole(value: object): boolean;
+export declare function RoleFromJSON(json: any): Role;
+export declare function RoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Role;
+export declare function RoleToJSON(value?: Role | null): any;

package/dist/esm/models/Role.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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.
+ */
+/**
+ * Check if a given object implements the Role interface.
+ */
+export function instanceOfRole(value) {
+    let isInstance = true;
+    isInstance = isInstance && "pk" in value;
+    isInstance = isInstance && "name" in value;
+    return isInstance;
+}
+export function RoleFromJSON(json) {
+    return RoleFromJSONTyped(json, false);
+}
+export function RoleFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'pk': json['pk'],
+        'name': json['name'],
+    };
+}
+export function RoleToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+    };
+}

package/dist/esm/models/RoleAssignedObjectPermission.d.ts

@@ -0,0 +1,44 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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 type { RoleObjectPermission } from './RoleObjectPermission';
+/**
+ * Roles assigned object permission serializer
+ * @export
+ * @interface RoleAssignedObjectPermission
+ */
+export interface RoleAssignedObjectPermission {
+    /**
+     *
+     * @type {string}
+     * @memberof RoleAssignedObjectPermission
+     */
+    readonly rolePk: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RoleAssignedObjectPermission
+     */
+    readonly name: string;
+    /**
+     *
+     * @type {Array<RoleObjectPermission>}
+     * @memberof RoleAssignedObjectPermission
+     */
+    permissions: Array<RoleObjectPermission>;
+}
+/**
+ * Check if a given object implements the RoleAssignedObjectPermission interface.
+ */
+export declare function instanceOfRoleAssignedObjectPermission(value: object): boolean;
+export declare function RoleAssignedObjectPermissionFromJSON(json: any): RoleAssignedObjectPermission;
+export declare function RoleAssignedObjectPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): RoleAssignedObjectPermission;
+export declare function RoleAssignedObjectPermissionToJSON(value?: RoleAssignedObjectPermission | null): any;

package/dist/esm/models/RoleAssignedObjectPermission.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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 { RoleObjectPermissionFromJSON, RoleObjectPermissionToJSON, } from './RoleObjectPermission';
+/**
+ * Check if a given object implements the RoleAssignedObjectPermission interface.
+ */
+export function instanceOfRoleAssignedObjectPermission(value) {
+    let isInstance = true;
+    isInstance = isInstance && "rolePk" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "permissions" in value;
+    return isInstance;
+}
+export function RoleAssignedObjectPermissionFromJSON(json) {
+    return RoleAssignedObjectPermissionFromJSONTyped(json, false);
+}
+export function RoleAssignedObjectPermissionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'rolePk': json['role_pk'],
+        'name': json['name'],
+        'permissions': (json['permissions'].map(RoleObjectPermissionFromJSON)),
+    };
+}
+export function RoleAssignedObjectPermissionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'permissions': (value.permissions.map(RoleObjectPermissionToJSON)),
+    };
+}

package/dist/esm/models/RoleObjectPermission.d.ts

@@ -0,0 +1,61 @@
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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.
+ */
+/**
+ * Role-bound object level permission
+ * @export
+ * @interface RoleObjectPermission
+ */
+export interface RoleObjectPermission {
+    /**
+     *
+     * @type {number}
+     * @memberof RoleObjectPermission
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RoleObjectPermission
+     */
+    readonly codename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RoleObjectPermission
+     */
+    readonly model: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RoleObjectPermission
+     */
+    readonly appLabel: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RoleObjectPermission
+     */
+    readonly objectPk: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RoleObjectPermission
+     */
+    readonly name: string;
+}
+/**
+ * Check if a given object implements the RoleObjectPermission interface.
+ */
+export declare function instanceOfRoleObjectPermission(value: object): boolean;
+export declare function RoleObjectPermissionFromJSON(json: any): RoleObjectPermission;
+export declare function RoleObjectPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): RoleObjectPermission;
+export declare function RoleObjectPermissionToJSON(value?: RoleObjectPermission | null): any;

package/dist/esm/models/RoleObjectPermission.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2023.8.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.
+ */
+/**
+ * Check if a given object implements the RoleObjectPermission interface.
+ */
+export function instanceOfRoleObjectPermission(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "codename" in value;
+    isInstance = isInstance && "model" in value;
+    isInstance = isInstance && "appLabel" in value;
+    isInstance = isInstance && "objectPk" in value;
+    isInstance = isInstance && "name" in value;
+    return isInstance;
+}
+export function RoleObjectPermissionFromJSON(json) {
+    return RoleObjectPermissionFromJSONTyped(json, false);
+}
+export function RoleObjectPermissionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'codename': json['codename'],
+        'model': json['model'],
+        'appLabel': json['app_label'],
+        'objectPk': json['object_pk'],
+        'name': json['name'],
+    };
+}
+export function RoleObjectPermissionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {};
+}