@goauthentik/api 2023.8.3-1696802918 → 2023.8.3-1697470337

package/src/models/Permission.ts

@@ -14,11 +14,17 @@
 
 import { exists, mapValues } from '../runtime';
 /**
- * Permission used for consent
+ * Global permission
  * @export
  * @interface Permission
  */
 export interface Permission {
+    /**
+     * 
+     * @type {number}
+     * @memberof Permission
+     */
+    readonly id: number;
     /**
      * 
      * @type {string}
@@ -30,7 +36,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;
 }
 
 /**
@@ -38,8 +68,13 @@ export interface Permission {
  */
 export function instanceOfPermission(value: object): boolean {
     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;
 }
@@ -54,8 +89,13 @@ export function PermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean)
     }
     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'],
     };
 }
 
@@ -69,7 +109,7 @@ export function PermissionToJSON(value?: Permission | null): any {
     return {
         
         'name': value.name,
-        'id': value.id,
+        'codename': value.codename,
     };
 }
 

package/src/models/PermissionAssignRequest.ts

@@ -0,0 +1,89 @@
+/* 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, mapValues } from '../runtime';
+import type { ModelEnum } from './ModelEnum';
+import {
+    ModelEnumFromJSON,
+    ModelEnumFromJSONTyped,
+    ModelEnumToJSON,
+} 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 function instanceOfPermissionAssignRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "permissions" in value;
+
+    return isInstance;
+}
+
+export function PermissionAssignRequestFromJSON(json: any): PermissionAssignRequest {
+    return PermissionAssignRequestFromJSONTyped(json, false);
+}
+
+export function PermissionAssignRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PermissionAssignRequest {
+    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?: PermissionAssignRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'permissions': value.permissions,
+        'model': ModelEnumToJSON(value.model),
+        'object_pk': value.objectPk,
+    };
+}
+

package/src/models/Role.ts

@@ -0,0 +1,74 @@
+/* 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, mapValues } from '../runtime';
+/**
+ * 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 function instanceOfRole(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "pk" in value;
+    isInstance = isInstance && "name" in value;
+
+    return isInstance;
+}
+
+export function RoleFromJSON(json: any): Role {
+    return RoleFromJSONTyped(json, false);
+}
+
+export function RoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Role {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pk': json['pk'],
+        'name': json['name'],
+    };
+}
+
+export function RoleToJSON(value?: Role | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+    };
+}
+

package/src/models/RoleAssignedObjectPermission.ts

@@ -0,0 +1,89 @@
+/* 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, mapValues } from '../runtime';
+import type { RoleObjectPermission } from './RoleObjectPermission';
+import {
+    RoleObjectPermissionFromJSON,
+    RoleObjectPermissionFromJSONTyped,
+    RoleObjectPermissionToJSON,
+} 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 function instanceOfRoleAssignedObjectPermission(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "rolePk" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "permissions" in value;
+
+    return isInstance;
+}
+
+export function RoleAssignedObjectPermissionFromJSON(json: any): RoleAssignedObjectPermission {
+    return RoleAssignedObjectPermissionFromJSONTyped(json, false);
+}
+
+export function RoleAssignedObjectPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): RoleAssignedObjectPermission {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'rolePk': json['role_pk'],
+        'name': json['name'],
+        'permissions': ((json['permissions'] as Array<any>).map(RoleObjectPermissionFromJSON)),
+    };
+}
+
+export function RoleAssignedObjectPermissionToJSON(value?: RoleAssignedObjectPermission | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'permissions': ((value.permissions as Array<any>).map(RoleObjectPermissionToJSON)),
+    };
+}
+

package/src/models/RoleObjectPermission.ts

@@ -0,0 +1,105 @@
+/* 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, mapValues } from '../runtime';
+/**
+ * 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 function instanceOfRoleObjectPermission(value: object): boolean {
+    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: any): RoleObjectPermission {
+    return RoleObjectPermissionFromJSONTyped(json, false);
+}
+
+export function RoleObjectPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): RoleObjectPermission {
+    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?: RoleObjectPermission | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+    };
+}
+

package/src/models/RoleRequest.ts

@@ -0,0 +1,66 @@
+/* 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, mapValues } from '../runtime';
+/**
+ * Role serializer
+ * @export
+ * @interface RoleRequest
+ */
+export interface RoleRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RoleRequest
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the RoleRequest interface.
+ */
+export function instanceOfRoleRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+
+    return isInstance;
+}
+
+export function RoleRequestFromJSON(json: any): RoleRequest {
+    return RoleRequestFromJSONTyped(json, false);
+}
+
+export function RoleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RoleRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+    };
+}
+
+export function RoleRequestToJSON(value?: RoleRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+    };
+}
+

package/src/models/User.ts

@@ -116,6 +116,12 @@ export interface User {
      * @memberof User
      */
     type?: UserTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof User
+     */
+    readonly uuid: string;
 }
 
 /**
@@ -130,6 +136,7 @@ export function instanceOfUser(value: object): boolean {
     isInstance = isInstance && "groupsObj" in value;
     isInstance = isInstance && "avatar" in value;
     isInstance = isInstance && "uid" in value;
+    isInstance = isInstance && "uuid" in value;
 
     return isInstance;
 }
@@ -158,6 +165,7 @@ export function UserFromJSONTyped(json: any, ignoreDiscriminator: boolean): User
         'uid': json['uid'],
         'path': !exists(json, 'path') ? undefined : json['path'],
         'type': !exists(json, 'type') ? undefined : UserTypeEnumFromJSON(json['type']),
+        'uuid': json['uuid'],
     };
 }
 

package/src/models/UserAssignedObjectPermission.ts

@@ -0,0 +1,148 @@
+/* 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, mapValues } from '../runtime';
+import type { UserObjectPermission } from './UserObjectPermission';
+import {
+    UserObjectPermissionFromJSON,
+    UserObjectPermissionFromJSONTyped,
+    UserObjectPermissionToJSON,
+} from './UserObjectPermission';
+
+/**
+ * Users assigned object permission serializer
+ * @export
+ * @interface UserAssignedObjectPermission
+ */
+export interface UserAssignedObjectPermission {
+    /**
+     * 
+     * @type {number}
+     * @memberof UserAssignedObjectPermission
+     */
+    readonly pk: number;
+    /**
+     * Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+     * @type {string}
+     * @memberof UserAssignedObjectPermission
+     */
+    username: string;
+    /**
+     * User's display name.
+     * @type {string}
+     * @memberof UserAssignedObjectPermission
+     */
+    name: string;
+    /**
+     * Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
+     * @type {boolean}
+     * @memberof UserAssignedObjectPermission
+     */
+    isActive?: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof UserAssignedObjectPermission
+     */
+    lastLogin?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserAssignedObjectPermission
+     */
+    email?: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof UserAssignedObjectPermission
+     */
+    attributes?: { [key: string]: any; };
+    /**
+     * 
+     * @type {string}
+     * @memberof UserAssignedObjectPermission
+     */
+    readonly uid: string;
+    /**
+     * 
+     * @type {Array<UserObjectPermission>}
+     * @memberof UserAssignedObjectPermission
+     */
+    permissions: Array<UserObjectPermission>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UserAssignedObjectPermission
+     */
+    isSuperuser: boolean;
+}
+
+/**
+ * Check if a given object implements the UserAssignedObjectPermission interface.
+ */
+export function instanceOfUserAssignedObjectPermission(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "pk" in value;
+    isInstance = isInstance && "username" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "uid" in value;
+    isInstance = isInstance && "permissions" in value;
+    isInstance = isInstance && "isSuperuser" in value;
+
+    return isInstance;
+}
+
+export function UserAssignedObjectPermissionFromJSON(json: any): UserAssignedObjectPermission {
+    return UserAssignedObjectPermissionFromJSONTyped(json, false);
+}
+
+export function UserAssignedObjectPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserAssignedObjectPermission {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pk': json['pk'],
+        'username': json['username'],
+        'name': json['name'],
+        'isActive': !exists(json, 'is_active') ? undefined : json['is_active'],
+        'lastLogin': !exists(json, 'last_login') ? undefined : (json['last_login'] === null ? null : new Date(json['last_login'])),
+        'email': !exists(json, 'email') ? undefined : json['email'],
+        'attributes': !exists(json, 'attributes') ? undefined : json['attributes'],
+        'uid': json['uid'],
+        'permissions': ((json['permissions'] as Array<any>).map(UserObjectPermissionFromJSON)),
+        'isSuperuser': json['is_superuser'],
+    };
+}
+
+export function UserAssignedObjectPermissionToJSON(value?: UserAssignedObjectPermission | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'username': value.username,
+        'name': value.name,
+        'is_active': value.isActive,
+        'last_login': value.lastLogin === undefined ? undefined : (value.lastLogin === null ? null : value.lastLogin.toISOString()),
+        'email': value.email,
+        'attributes': value.attributes,
+        'permissions': ((value.permissions as Array<any>).map(UserObjectPermissionToJSON)),
+        'is_superuser': value.isSuperuser,
+    };
+}
+