@keboola/api-client 21.0.0 → 23.0.0

package/dist/{types-DJLceKR0.d.ts → types-GecGaYgv.d.cts}

@@ -4,6 +4,38 @@
  */
 
 type paths = {
+  '/manage/users': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List users
+     * @description Returns all users (admins), each with their assigned features, MFA/super-admin state, and
+     *     membership counts (organizations, projects, maintainers).
+     *
+     *     Listing is allowed only for a super admin or a user with feature `can-manage-users`.
+     *
+     *     #### Filtering
+     *
+     *     * *q* - fulltext filter matched against the user name or email
+     *
+     *     #### Pagination
+     *
+     *     * *limit* - number of returned users; default value: 20
+     *     * *offset* - pagination offset
+     */
+    get: operations['get_/manage/users::UserListAction'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   '/manage/commands': {
     parameters: {
       query?: never;
@@ -2329,6 +2361,50 @@ type paths = {
     patch?: never;
     trace?: never;
   };
+  '/manage/users/{id}/super-admin': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Grant super admin privilege to User
+     * @description Grants super admin privileges to the specified user. Requires the target user to already have
+     *     multi-factor authentication enabled — there is no way to override this precondition over the API
+     *     (use the `manage:user:set-super-admin --force-no-mfa` CLI command instead).
+     *
+     *     Only a super admin may grant this privilege; having the `can-manage-users` feature is not enough.
+     */
+    post: operations['post_/manage/users/{id}/super-admin::UserGrantSuperAdminAction'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/manage/users/{id}/maintainers': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List user's maintainers
+     * @description Returns the maintainers the user is a member of.
+     */
+    get: operations['get_/manage/users/{id}/maintainers::UserListMaintainersAction'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   '/manage/users/{idOrEmail}/metadata': {
     parameters: {
       query?: never;
@@ -2360,6 +2436,46 @@ type paths = {
     patch?: never;
     trace?: never;
   };
+  '/manage/users/{id}/organizations': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List user's organizations
+     * @description Returns the organizations the user is a member of, each with the membership creation date, who invited the user (if known), and the organization's maintainer.
+     */
+    get: operations['get_/manage/users/{id}/organizations::UserListOrganizationsAction'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/manage/users/{id}/projects': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List user's projects
+     * @description Returns the projects the user is a member of, including role, membership status, expiration, creation date, reason, and who invited the user (if known).
+     */
+    get: operations['get_/manage/users/{id}/projects::UserListProjectsAction'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   '/manage/users/{idOrEmail}/features/{featureName}': {
     parameters: {
       query?: never;
@@ -2427,6 +2543,14 @@ type paths = {
 };
 type components = {
   schemas: {
+    UserListRequest: {
+      /** @description Fulltext filter matched against the user name or email (substring, case-insensitive). */
+      q?: string | null;
+      /** @description Maximum number of users to return. Default value: 20. */
+      limit?: number | null;
+      /** @description Pagination offset. Default value: 0. */
+      offset?: number | null;
+    };
     /** @description CLI command enqueue request payload. */
     EnqueueCommandRequest: {
       /**
@@ -2833,11 +2957,6 @@ type components = {
       defaultFileStorageId?: number | null;
     };
     SamlConfigCompleteSetupRequest: {
-      /**
-       * @description One-time setup token from initial configuration
-       * @example a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6
-       */
-      setupToken: string;
       /**
        * @description Identity Provider entity ID
        * @example http://www.okta.com/exk123456
@@ -3225,6 +3344,60 @@ type components = {
       /** @description Identifier of the project to top up. Must be a positive integer. */
       idProject: number;
     };
+    UserListResponse: {
+      /**
+       * @description User identifier.
+       * @example 2
+       */
+      id: number;
+      /**
+       * @description User full name.
+       * @example Martin
+       */
+      name: string;
+      /**
+       * @description User email address.
+       * @example martin@keboola.com
+       */
+      email: string;
+      /**
+       * @description Whether MFA is enabled for the user.
+       * @example true
+       */
+      mfaEnabled: boolean;
+      /**
+       * @description List of assigned features.
+       * @example [
+       *       "inline-manual"
+       *     ]
+       */
+      features: string[];
+      /**
+       * @description Whether the user can access logs.
+       * @example true
+       */
+      canAccessLogs: boolean;
+      /**
+       * @description Whether the user has super admin privileges.
+       * @example true
+       */
+      isSuperAdmin: boolean;
+      /**
+       * @description Number of organizations the user is a member of.
+       * @example 2
+       */
+      organizationsCount: number;
+      /**
+       * @description Number of projects the user is a member of.
+       * @example 5
+       */
+      projectsCount: number;
+      /**
+       * @description Number of maintainers the user is a member of.
+       * @example 1
+       */
+      maintainersCount: number;
+    }[];
     EnqueueCommandResponse: {
       /**
        * @description Identifier of the enqueued command execution; this ID is appended to all logs produced by the command.
@@ -4981,6 +5154,73 @@ type components = {
         commitSha?: string | null;
       };
     };
+    UserListMaintainersResponse: {
+      maintainer: {
+        /** @example 123 */
+        id: number;
+        /** @example Keboola CZ */
+        name: string | null;
+      };
+    }[];
+    UserListOrganizationsResponse: {
+      organization: {
+        /** @example 1 */
+        id: number;
+        /** @example Keboola Tests */
+        name: string;
+      };
+      /**
+       * Format: date-time
+       * @example 2014-11-11T08:40:51+0000
+       */
+      created: string | null;
+      invitedBy: {
+        /** @example 1 */
+        id: number;
+        /** @example Martin */
+        name: string;
+        /** @example martin@keboola.com */
+        email: string;
+      } | null;
+      maintainer: {
+        /** @example 123 */
+        id: number;
+        /** @example Keboola CZ */
+        name: string | null;
+      };
+    }[];
+    UserListProjectsResponse: {
+      project: {
+        /** @example 4088 */
+        id: number;
+        /** @example Test project */
+        name: string;
+      };
+      /** @example admin */
+      role: string;
+      /** @example active */
+      status: string;
+      /**
+       * Format: date-time
+       * @example null
+       */
+      expires: string | null;
+      /**
+       * Format: date-time
+       * @example 2016-02-29T08:01:13+0000
+       */
+      created: string | null;
+      /** @example  */
+      reason: string;
+      invitedBy: {
+        /** @example 1 */
+        id: number;
+        /** @example Martin */
+        name: string;
+        /** @example martin@keboola.com */
+        email: string;
+      } | null;
+    }[];
     TryTopUpRequest2: {
       /** @description Identifier of the project to top up. Must be a positive integer. */
       idProject: number;
@@ -4994,6 +5234,47 @@ type components = {
   pathItems: never;
 };
 type operations = {
+  'get_/manage/users::UserListAction': {
+    parameters: {
+      query?: {
+        /** @description Fulltext filter matched against the user name or email (substring, case-insensitive). */
+        q?: string | null;
+        /** @description Maximum number of users to return. Default value: 20. */
+        limit?: number | null;
+        /** @description Pagination offset. Default value: 0. */
+        offset?: number | null;
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description List of users. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['UserListResponse'];
+        };
+      };
+      /** @description Returned when the Manage token is missing or invalid. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the current admin cannot list users. */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   'post_/manage/commands::CommandEnqueueAction': {
     parameters: {
       query?: never;
@@ -8498,7 +8779,7 @@ type operations = {
           };
         };
       };
-      /** @description Invalid or expired setup token, or invalid request data */
+      /** @description Invalid request data */
       400: {
         headers: {
           [name: string]: unknown;
@@ -8520,6 +8801,17 @@ type operations = {
           };
         };
       };
+      /** @description SAML configuration is already active */
+      409: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': {
+            error?: string;
+          };
+        };
+      };
     };
   };
   'get_/manage/maintainers/{maintainerId}/saml::SamlConfigListAction': {
@@ -8592,9 +8884,6 @@ type operations = {
             customerSlug?: string;
             name?: string;
             isActive?: boolean;
-            setupToken?: string;
-            /** Format: date-time */
-            setupTokenExpiresAt?: string;
             spConfiguration?: {
               entityId?: string;
               acsUrl?: string;
@@ -13969,6 +14258,120 @@ type operations = {
       };
     };
   };
+  'post_/manage/users/{id}/super-admin::UserGrantSuperAdminAction': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /**
+         * @description User identifier.
+         * @example 2
+         */
+        id: number;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Updated user detail. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          /**
+           * @example {
+           *       "id": 2,
+           *       "name": "Martin",
+           *       "email": "martin@keboola.com",
+           *       "features": [
+           *         "inline-manual"
+           *       ],
+           *       "mfaEnabled": true,
+           *       "canAccessLogs": true,
+           *       "isSuperAdmin": true
+           *     }
+           */
+          'application/json': components['schemas']['UserResponse'];
+        };
+      };
+      /** @description Returned when the Manage token is missing or invalid. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the current admin is not a super admin. */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the user does not exist. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the target user does not have MFA enabled. */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  'get_/manage/users/{id}/maintainers::UserListMaintainersAction': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /**
+         * @description User identifier.
+         * @example 2
+         */
+        id: number;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description List of the user's maintainers. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['UserListMaintainersResponse'];
+        };
+      };
+      /** @description Returned when the Manage token is missing or invalid. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the current admin cannot access this user. */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the user does not exist. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   'get_/manage/users/{idOrEmail}/metadata::UserListMetadataAction': {
     parameters: {
       query?: never;
@@ -14170,6 +14573,100 @@ type operations = {
       };
     };
   };
+  'get_/manage/users/{id}/organizations::UserListOrganizationsAction': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /**
+         * @description User identifier.
+         * @example 2
+         */
+        id: number;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description List of the user's organizations. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['UserListOrganizationsResponse'];
+        };
+      };
+      /** @description Returned when the Manage token is missing or invalid. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the current admin cannot access this user. */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the user does not exist. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  'get_/manage/users/{id}/projects::UserListProjectsAction': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /**
+         * @description User identifier.
+         * @example 2
+         */
+        id: number;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description List of the user's projects. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['UserListProjectsResponse'];
+        };
+      };
+      /** @description Returned when the Manage token is missing or invalid. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the current admin cannot access this user. */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Returned when the user does not exist. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
   'delete_/manage/users/{idOrEmail}/features/{featureName}::UserRemoveFeatureAction': {
     parameters: {
       query?: never;
@@ -14355,10 +14852,9 @@ type operations = {
 };
 
 /** A single deleted project as returned by `GET /manage/deleted-projects` or
- * `GET /manage/deleted-projects/{projectId}`. The generated schema now models the owning
- * `organization` (added to the backend OpenAPI after M7 — see
- * docs/prototype-specs/m7-api-discrepancy-report.md), so no overlay is needed; note its `id`/`name`
- * members are optional in the spec, so consumers access them defensively. */
+ * `GET /manage/deleted-projects/{projectId}`. The generated schema models the owning `organization`
+ * (added to the backend OpenAPI by keboola/connection#7794), so no overlay is needed; note its
+ * `id`/`name` members are optional in the spec, so consumers access them defensively. */
 type DeletedProject = components['schemas']['DeletedProjectResponse'];
 /** Query parameters accepted by `GET /manage/deleted-projects`. */
 type DeletedProjectsListQuery = components['schemas']['DeletedProjectsListRequest'];
@@ -14698,5 +15194,11 @@ type User = {
     isSuperAdmin: boolean;
     canApproveMergeRequests: boolean;
 };
+type UserDetail = components['schemas']['UserResponse'];
+type UserListItem = components['schemas']['UserListResponse'][number];
+type UserOrganizationMembership = components['schemas']['UserListOrganizationsResponse'][number];
+type UserProjectMembership = components['schemas']['UserListProjectsResponse'][number];
+type UserMaintainerMembership = components['schemas']['UserListMaintainersResponse'][number];
+type GetUsersQuery = NonNullable<operations['get_/manage/users::UserListAction']['parameters']['query']>;
 
-export type { ProjectTemplate as $, AddMaintainerUserBody as A, GetProjectPath as B, CreateMaintainerBody as C, DeleteProjectInvitationPath as D, GetProjectReviewersPath as E, Feature as F, GetAllFeaturesQuery as G, GetStorageBackendProjectsQuery as H, ListProjectUsersPath as I, MaintainerDetail as J, MaintainerInvitationDetail as K, ListProjectInvitationsPath as L, Maintainer as M, MaintainerUser as N, MetadataItem as O, MoveProjectBody as P, Organization as Q, OrganizationDetail as R, OrganizationInvitationDetail as S, OrganizationListItem as T, OrganizationMaintainer as U, OrganizationProject as V, Project as W, ProjectInvitableRole as X, ProjectInvitationDetail as Y, ProjectMetadataInput as Z, ProjectMetadataItem as _, AddOrganizationUserBody as a, RemoveProjectFeaturePath as a0, RemoveProjectUserPath as a1, RemoveUserFeaturePath as a2, Reviewer as a3, SetMaintainerMetadataBody as a4, SetOrganizationMetadataBody as a5, SetProjectDisabledBody as a6, SetProjectLimitsBody as a7, SetProjectMetadataBody as a8, SetProjectMetadataPath as a9, SetProjectReviewersBody as aa, SetProjectReviewersPath as ab, StorageBackend as ac, StorageBackendMaintainer as ad, StorageBackendProject as ae, UpdateMaintainerBody as af, UpdateOrganizationBody as ag, UpdateProjectBody as ah, User as ai, AddProjectUserBody as b, components as c, AddProjectUserPath as d, AddUserFeatureBody as e, AddUserFeaturePath as f, AdminUser as g, CreateMaintainerInvitationBody as h, CreateMaintainerOrganizationBody as i, CreateOrganizationInvitationBody as j, CreateOrganizationProjectBody as k, CreateProjectFeatureBody as l, CreateProjectFeaturePath as m, CreateProjectInvitationBody as n, CreateProjectInvitationPath as o, DeletedProject as p, DeletedProjectPurgeResult as q, DeletedProjectsListQuery as r, FeatureAdmin as s, FeatureProject as t, FeatureType as u, FileStorage as v, FileStorageAbs as w, FileStorageGcs as x, FileStorageS3 as y, GetProjectMetadataPath as z };
+export type { ProjectMetadataItem as $, AddMaintainerUserBody as A, GetProjectPath as B, CreateMaintainerBody as C, DeleteProjectInvitationPath as D, GetProjectReviewersPath as E, Feature as F, GetAllFeaturesQuery as G, GetStorageBackendProjectsQuery as H, GetUsersQuery as I, ListProjectUsersPath as J, MaintainerDetail as K, ListProjectInvitationsPath as L, Maintainer as M, MaintainerInvitationDetail as N, MaintainerUser as O, MetadataItem as P, MoveProjectBody as Q, Organization as R, OrganizationDetail as S, OrganizationInvitationDetail as T, OrganizationListItem as U, OrganizationMaintainer as V, OrganizationProject as W, Project as X, ProjectInvitableRole as Y, ProjectInvitationDetail as Z, ProjectMetadataInput as _, AddOrganizationUserBody as a, ProjectTemplate as a0, RemoveProjectFeaturePath as a1, RemoveProjectUserPath as a2, RemoveUserFeaturePath as a3, Reviewer as a4, SetMaintainerMetadataBody as a5, SetOrganizationMetadataBody as a6, SetProjectDisabledBody as a7, SetProjectLimitsBody as a8, SetProjectMetadataBody as a9, SetProjectMetadataPath as aa, SetProjectReviewersBody as ab, SetProjectReviewersPath as ac, StorageBackend as ad, StorageBackendMaintainer as ae, StorageBackendProject as af, UpdateMaintainerBody as ag, UpdateOrganizationBody as ah, UpdateProjectBody as ai, User as aj, UserDetail as ak, UserListItem as al, UserMaintainerMembership as am, UserOrganizationMembership as an, UserProjectMembership as ao, AddProjectUserBody as b, components as c, AddProjectUserPath as d, AddUserFeatureBody as e, AddUserFeaturePath as f, AdminUser as g, CreateMaintainerInvitationBody as h, CreateMaintainerOrganizationBody as i, CreateOrganizationInvitationBody as j, CreateOrganizationProjectBody as k, CreateProjectFeatureBody as l, CreateProjectFeaturePath as m, CreateProjectInvitationBody as n, CreateProjectInvitationPath as o, DeletedProject as p, DeletedProjectPurgeResult as q, DeletedProjectsListQuery as r, FeatureAdmin as s, FeatureProject as t, FeatureType as u, FileStorage as v, FileStorageAbs as w, FileStorageGcs as x, FileStorageS3 as y, GetProjectMetadataPath as z };