@favish/staffbase-utils 0.15.0 → 0.17.0

package/dist/src/types/user/generated/userApi.d.ts

@@ -0,0 +1,1525 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/users": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List users
+         * @description This endpoint returns all users on the platform with their available data.
+         *
+         *     <div class="sb-box sb-box--note">
+         *        For more advanced searches, use the <a href='https://developers.staffbase.com/api/api-user/#tag/Users/operation/searchUsersOfBranch' target='_blank' rel='noopener noreferrer'>search user endpoint</a>.
+         *     </div>
+         */
+        get: operations["GetUsers"];
+        put?: never;
+        /**
+         * Invite new users
+         * @description This endpoint invites a new user to the platform.
+         */
+        post: operations["InviteUser"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Search users
+         * @description This endpoint searches users on the platform based on the parameters given.
+         */
+        get: operations["searchUsersOfBranch"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{userId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Return a user
+         * @description This endpoint returns a single user based on the user's identifier.
+         */
+        get: operations["GetSpecificUser"];
+        /**
+         * Update a user
+         * @description This endpoint updates a user by an incremental update.
+         *     <div class="sb-box sb-box--alert">
+         *      This is a legacy endpoint and is planned to be <a href='https://developers.staffbase.com/concepts/api-versioning/' target='_blank' rel='noopener noreferrer'>deprecated</a> in the future. Use the <a href='https://developers.staffbase.com/api/api-user#tag/User/operation/updateUser' target='_blank' rel='noopener noreferrer'>PATCH method</a> instead.
+         *     </div>
+         *
+         *     See also further details on example use cases: <a href='https://developers.staffbase.com/use-cases/update-profilefields-via-userapi/' target='_blank' rel='noopener noreferrer'>Update user standard fields</a>,
+         *     <a href='https://developers.staffbase.com/use-cases/update-avatar-via-userapi/' target='_blank' rel='noopener noreferrer'>Update user avatar</a> and
+         *     <a href='https://developers.staffbase.com/use-cases/offboarding-users/#deactivate-user-accounts' target='_blank' rel='noopener noreferrer'>Deactivate a user</a>.
+         */
+        put: operations["UpdateUser"];
+        post?: never;
+        /**
+         * Delete a user
+         * @description This endpoint deletes a user from the platform. Deleted user accounts cannot be restored by administrators or Staffbase. To regain access, a new user account must be created. Constraint: The last remaining administrator on the platform cannot be deleted.
+         */
+        delete: operations["DeleteUser"];
+        options?: never;
+        head?: never;
+        /**
+         * Update a user
+         * @description This endpoint partially updates user properties. Provide only the properties you want to update. This method replaces the <a href='https://developers.staffbase.com/api/api-user#tag/User/operation/UpdateUser' target='_blank' rel='noopener noreferrer'>PUT method</a>.
+         *      </div>
+         */
+        patch: operations["updateUser"];
+        trace?: never;
+    };
+    "/users/{userId}/groups": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List groups of a user
+         * @description This endpoint returns a list of groups the requested user is a member of.
+         */
+        get: operations["GetGroupsOfUser"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{userId}/groups/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a user's groups
+         * @description This endpoint returns the groups of a user sorted by their creation date and can search by group name. It can be called by admins and group admins.
+         */
+        get: operations["GetUserGroups"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{userId}/groups/visible": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List visible groups a user
+         * @description This endpoint returns a list of groups the user is a member of. Groups are filtered by <a href="https://support.staffbase.com/hc/en-us/articles/360010803979-Types-of-User-Groups" target="_blank">type</a> and conditional groups are omitted.
+         */
+        get: operations["GetVisibleGroupsOfUser"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{userId}/recovery": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Send recovery email
+         * @description This endpoint sends an email to the specified user to recover their account.
+         */
+        post: operations["UserRecovery"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{userId}/sessions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Log a user out
+         * @description This endpoint invalidates all active sessions that belong to the given user.
+         */
+        delete: operations["DeleteUserSessions"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/sync": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List users by timestamp
+         * @description This endpoint returns users in order of their updated timestamp along with a cursor to continue after the latest returned users.
+         */
+        get: operations["Sync"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * Schema to create a user
+         * @description Schema to create a user
+         */
+        CreateUser: {
+            /** @description The department of the user. Value will be also set to `profile.department`. */
+            department?: string;
+            /** @description The primary email of the user. When a new user has signed up and set the primary email themselves, that email can not be changed via API afterwards. Has to be unique per application. */
+            "emails/primary"?: string;
+            /** @description This id can be set as an external id to identify the user in your organisation. Therefore, this property needs to be unique, too. It is recommended to **not modify this id** once set - to avoid duplication of users. See also our Support article <a href="https://support.staffbase.com/hc/en-us/articles/360020766759-Identifiers-for-Your Users-in-the-Staffbase-Platform" target="_blank"> Identifiers for Your Users in the Staffbase Platform</a>. The externalID is only visible to the admin. */
+            externalID?: string;
+            /** @description The first name of the user. */
+            firstName?: string;
+            /** @description Optional message to be included in the invitation mail, when inviting a new user to the App. */
+            inviteMessage?: string;
+            /** @description The last name of the user. */
+            lastName?: string;
+            /** @description The location of the user. Value will be also set to `profile.location`. */
+            location?: string;
+            /** @description A set of groups where this user may not unsubscribe from. Needs user management rights to execute. See the <a href="https://support.staffbase.com/hc/en-us/sections/360003247419-Mandatory-Group-Management" target="_blank"> mandatory group management section</a> on our support portal. */
+            mandatoryGroupIDs?: string[];
+            /** @description The public email address of the user. Value will be also set to `profile.publicEmailAddress`. This email address will not be used to send information to the user. It is only shown in the user profile. */
+            publicEmailAddress?: string;
+            /** @description The phone number of the user. Value will be also set to `profile.phoneNumber`. */
+            phoneNumber?: string;
+            /** @description The position of the user. Value will be also set to `profile.position`. */
+            position?: string;
+            profile?: components["schemas"]["UserProfile"];
+            /** @description The recovery code of a user to reset the password. See the <a href="https://support.staffbase.com/hc/en-us/sections/360002122511-Account-Recovery" target="_blank">account recovery section</a> on our support portal. The recovery code does not follow the password policy defined for the App. Use `recoveryCodeExpires` to set an expiration date. */
+            recoveryCode?: string;
+            /** @description Expiration date of the recovery code. */
+            recoveryCodeExpires?: number;
+            /** @description The role of the user. See also <a href="/basic-concepts/role-type/#role-type" target="_blank"> User Role Type</a>. */
+            role?: {
+                type?: string;
+            };
+            /** @description The secret of the user. This parameter cannot be changed anymore when the user status has changed from pending to activated. If no secret property is provided, we will auto-generate a secret based on the password policy of your App. In case you create users without an identifier like email or userName, the <b>secret</b> for those users will be handled as an access code which has to be <b>unique</b>. See also our articles <a href="https://support.staffbase.com/hc/en-us/articles/360002609791-Onboarding-with-an-Access-Code" target="_blank">Onboarding with an Access Code</a> and <a href="https://support.staffbase.com/hc/en-us/articles/360010062120-Adding-Users-Manually-via-Access-Code" target="_blank">Adding Users Manually via Access Code</a>. */
+            secret?: string;
+            /**
+             * @description This property determines if an email invitation is sent out from the Staffbase platform to the primary email address of a pending user. Only set this property to `true` when the invitation email is intended. If the user is equipped with an email you can send an email invitation to the new user by setting the *sendMail* parameter to `true`. The user receives an email to sign up for the app. <div class="sb-box sb-box--tip"> When the <span class="mdx-code">sendMail</span> parameter is not included or specified in the request, by default it is set with the value <span class="mdx-code">true</span>. If you do not want the email invitation to be sent out, set the <span class="mdx-code">sendMail</span> parameter with the value <span class="mdx-code">false</span>.  </div> See the <a href="/basic-concepts/user-model" target="_blank">user model</a> for more information on all available properties.
+             * @example false
+             */
+            sendMail?: boolean;
+            /** @description A set of tags for this user for easier access. When a user gets imported via CSV, for example, we can tag the user with some attributes. This is useful, for example, for managing <a href="https://support.staffbase.com/hc/en-us/articles/360010633120-Setting-Up-Tags-for-Conditional-Groups" target="_blank"> conditional groups</a>. Tags created from profile fields configured for Group Tagging cannot be altered directly via this attribute. The profile field value must be updated which will then also update the tag. */
+            tags?: string[];
+            /** @description The unique username a user logs in with. */
+            userName?: string;
+        };
+        UserAvatar: {
+            original?: {
+                /** @example https://{{sb-host}}.com/{{sb-system}}/image/upload/v1631172776/{{shortened}}/603b64e00c3fdb29134eb89b.png */
+                url?: string;
+                /** @example 225 */
+                width?: number;
+                /** @example 225 */
+                height?: number;
+                /** @example 4650 */
+                size?: number;
+                /** @example png */
+                format?: string;
+                /** @example image/png */
+                mimeType?: string;
+                /** @example 2021-09-09T07:32:56.000Z */
+                created?: string;
+            };
+            icon?: {
+                /** @example https://{{sb-host}}.com/{{sb-system}}/image/upload/v1631172776/{{shortened}}/603b64e00c3fdb29134eb89b.png */
+                url?: string;
+                /** @example null */
+                format?: string;
+                /** @example null */
+                mimeType?: string;
+            };
+            thumb?: {
+                /** @example https://{{sb-host}}.com/{{sb-system}}/image/upload/v1631172776/{{shortened}}/603b64e00c3fdb29134eb89b.png */
+                url?: string;
+                /** @example null */
+                format?: string;
+                /** @example null */
+                mimeType?: string;
+            };
+        };
+        /**
+         * A single user
+         * @description A single user
+         */
+        SingleUserWithAvatar: {
+            /** @example 2021-07-28T06:49:15.462Z */
+            activated?: string;
+            avatar?: components["schemas"]["UserAvatar"];
+            config?: {
+                /** @example en_US */
+                locale?: string;
+            };
+            /** @example 2021-07-22T09:14:39.146Z */
+            created?: string;
+            /** @example Development & Research */
+            department?: string;
+            /**
+             * @example [
+             *       {
+             *         "value": "john@doe.com",
+             *         "primary": true,
+             *         "providerID": "staffbase"
+             *       }
+             *     ]
+             */
+            emails?: Record<string, never>[];
+            /** @example jd123 */
+            externalID?: string;
+            /** @example John */
+            firstName?: string;
+            /**
+             * @example [
+             *       "c69e7b20e6504345aa4b4938",
+             *       "9e7b20e6504dfa90a4345aa3"
+             *     ]
+             */
+            groupIDs?: unknown;
+            /** @example 20e6504df8a90a4345aa4b49 */
+            id?: string;
+            /** @example Doe */
+            lastName?: string;
+            /** @example Chemnitz */
+            location?: string;
+            /**
+             * @example [
+             *       "c69e7b20e6504345aa4b4938"
+             *     ]
+             */
+            mandatoryGroupIDs?: unknown;
+            /** @example +491234567890 */
+            phoneNumber?: string;
+            /** @example Developer */
+            position?: string;
+            profile?: {
+                avatar?: components["schemas"]["UserAvatar"];
+                /** @example Development & Research */
+                department?: string;
+                /** @example John */
+                firstName?: string;
+                /** @example Doe */
+                lastName?: string;
+                /** @example Chemnitz */
+                location?: string;
+                /** @example +491234567890 */
+                phoneNumber?: string;
+                /** @example Developer */
+                position?: string;
+                /** @example hi@example.com */
+                publicEmailAddress?: string;
+            };
+            /** @example hi@example.com */
+            publicEmailAddress?: string;
+            role?: {
+                /** @example admin */
+                type?: string;
+            };
+            /**
+             * @description This status of the user on the platform The status `contact` is only applicable if you have Staffbase Email.
+             * @example activated
+             * @enum {string}
+             */
+            status?: "pending" | "activated" | "deactivated" | "contact";
+            /** @example 2021-08-16T15:15:45.668 */
+            updated?: string;
+        };
+        /** @description Returns a list of groups. */
+        ReturnGroups: {
+            /** @example 1 */
+            total?: number;
+            /** @example 100 */
+            limit?: number;
+            /** @example 0 */
+            offset?: number;
+            data?: {
+                /** @example 5fad53cd85ebee1b0fde6f5d */
+                id?: unknown;
+                /** @example f8c6de49-2c08-40e4-8df8-a5aac98de43c */
+                externalID?: unknown;
+                /** @example My awesome group */
+                name?: unknown;
+                /** @example enumeration */
+                type?: unknown;
+                /** @example 20e6504df8a90a4345aa4b49 */
+                ownerID?: unknown;
+                users?: components["schemas"]["ReturnUsers"];
+            };
+        };
+        /** @description Returns a list of users matching the query and/or filter parameters. Each user in the response matches our user model. */
+        ReturnUsers: {
+            /** @example 1 */
+            total?: number;
+            /** @example 100 */
+            limit?: number;
+            /** @example 0 */
+            offset?: number;
+            data?: components["schemas"]["SingleUserWithAvatar"][];
+        };
+        UpdateUser: {
+            /** @description The department of the user. Value will be also set to `profile.department`. */
+            department?: string;
+            /** @description The primary email of the user. When a new user has signed up and set the primary email themselves, that email can not be changed via API afterwards. Has to be unique per branch. */
+            "emails/primary"?: string;
+            /** @description This id can be set as an external id to identify the user in your organisation. Therefore, this property needs to be unique, too. It is recommended to **not modify this id** once set - to avoid duplication of users. See also our Support article <a href="https://support.staffbase.com/hc/en-us/articles/360020766759-Identifiers-for-Your-Users-in-the-Staffbase-Platform" target="_blank"> Identifiers for Your Users in the Staffbase Platform</a>. The externalID is only visible to the admin. */
+            externalID?: string;
+            /** @description The first name of the user. */
+            firstName?: string;
+            /** @description Optional message to be included in the invitation mail, when inviting a new user to the App. */
+            inviteMessage?: string;
+            /** @description The last name of the user. */
+            lastName?: string;
+            /** @description The location of the user. Value will be also set to `profile.location`. */
+            location?: string;
+            /** @description A set of groups where this user may not unsubscribe from. Needs user management rights to execute. See the <a href="https://support.staffbase.com/hc/en-us/sections/360003247419-Mandatory-Group-Management" target="_blank"> mandatory group management section</a> on our support portal. */
+            mandatoryGroupIDs?: string[];
+            /** @description The public email address of the user. Value will be also set to `profile.publicEmailAddress`. This email address will not be used to send information to the user. It is only shown in the user profile. */
+            publicEmailAddress?: string;
+            /** @description The phone number of the user. Value will be also set to `profile.phoneNumber`. */
+            phoneNumber?: string;
+            /** @description The position of the user. Value will be also set to `profile.position`. */
+            position?: string;
+            profile?: components["schemas"]["UserProfile"];
+            /** @description The recovery code of a user to reset the password. See the <a href="https://support.staffbase.com/hc/en-us/sections/360002122511-Account-Recovery" target="_blank">account recovery section</a> on our support portal. The recovery code does not follow the password policy defined for the App. Use `recoveryCodeExpires` to set an expiration date. */
+            recoveryCode?: string;
+            /** @description Expiration date of the recovery code. */
+            recoveryCodeExpires?: number;
+            /** @description The role of the user. See also <a href="/basic-concepts/role-type/#role-type" target="_blank"> User Role Type</a>. */
+            role?: {
+                [key: string]: {
+                    /** @description The role type defines the role a user could have in your organisation. */
+                    type?: string;
+                };
+            };
+            /**
+             * @description This status of the user on the platform. The status `contact` is only applicable if you have Staffbase Email.
+             * @example activated
+             * @enum {string}
+             */
+            status?: "pending" | "activated" | "deactivated" | "deleted" | "contact";
+            /** @description This property determines if an email invitation is sent out from the Staffbase platform to the primary email address of a pending user. Only set this property to `true` when the invitation email is intended. */
+            sendMail?: boolean;
+            /** @description A set of tags for this user for easier access. When a user gets imported via CSV, for example, we can tag the user with some attributes. This is useful, for example, for managing <a href="https://support.staffbase.com/hc/en-us/articles/360010633120-Setting-Up-Tags-for-Conditional-Groups" target="_blank"> conditional groups</a>. Tags created from profile fields configured for Group Tagging cannot be altered directly via this attribute. The profile field value must be updated which will then also update the tag. */
+            tags?: string[];
+            /**
+             * @description The user name of the user. Has to be unique per branch.
+             * @example MyNewUsername1
+             */
+            userName?: string;
+        };
+        /** @description Fills a profile field for a user. See the <a href="https://developers.staffbase.com/basic-concepts/user-model/" target="_blank">user model</a>. */
+        UserProfile: {
+            /** @description The first name of the user. */
+            firstName?: string;
+            /** @description The last name of the user. */
+            lastName?: string;
+            /** @description The department of the user. */
+            department?: string;
+            /** @description The location of the user. */
+            location?: string;
+            /** @description The position or job title of the user. */
+            position?: string;
+            /** @description The phone number of the user. */
+            phoneNumber?: string;
+            /** @description The public email address of the user. Only shown in the user profile, not used for login or notifications. */
+            publicEmailAddress?: string;
+            avatar?: components["schemas"]["UserAvatar"];
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description <a href="https://support.staffbase.com/hc/en-us/articles/25487559570834" target="_blank">System and custom profile fields</a> for a user. System fields are listed as named properties, and custom profile fields are supported as additional properties. */
+        UserDataProfile: {
+            /** @description The first name of the user. */
+            firstName?: string;
+            /** @description The last name of the user. */
+            lastName?: string;
+            /** @description The department of the user. */
+            department?: string;
+            /** @description The location of the user. */
+            location?: string;
+            /** @description The position or job title of the user. */
+            position?: string;
+            /** @description The phone number of the user. */
+            phoneNumber?: string;
+            /** @description The public email address of the user. Only shown in the user profile, not used for login or notifications. */
+            publicEmailAddress?: string;
+            avatar?: components["schemas"]["UserAvatar"];
+        } & {
+            [key: string]: unknown;
+        };
+        /**
+         * @description The status of the user on the platform. The status `contact` is only applicable if you have Staffbase Email.
+         * @enum {string}
+         */
+        UserStatus: "pending" | "activated" | "deactivated" | "deleted" | "contact";
+        /**
+         * Schema to create a user
+         * @description Schema to create a user
+         */
+        CreateUserInMarketingResponse: {
+            /** @example 5fb67f23dd7c407fbdd11517 */
+            branchID?: unknown;
+            /** @example WeBranchAdminRole */
+            branchRole?: unknown;
+            config?: {
+                /** @example en_US */
+                locale?: unknown;
+                notificationSettings?: {
+                    chat?: {
+                        /** @example true */
+                        push?: string;
+                    };
+                    comments?: {
+                        /** @example true */
+                        push?: string;
+                    };
+                    mentions?: {
+                        /** @example true */
+                        push?: string;
+                    };
+                    posts?: {
+                        /** @example true */
+                        push?: string;
+                    };
+                };
+            };
+            /** @example 2023-03-20T09:06:53.753Z */
+            created?: unknown;
+            /** @example Marketing */
+            department?: unknown;
+            /**
+             * @example [
+             *       {
+             *         "value": "marketing@example.com",
+             *         "primary": true,
+             *         "providerID": "staffbase"
+             *       }
+             *     ]
+             */
+            emails?: unknown;
+            /** @example user */
+            entityType?: unknown;
+            /** @example 209tz9hgbrevkmfkq03j */
+            externalID?: unknown;
+            /** @example Mike */
+            firstName?: unknown;
+            /** @example [] */
+            groupIDs?: unknown;
+            /** @example 6418222d81275f1a9f539a56 */
+            id?: unknown;
+            /** @example Welcome to our App! */
+            inviteMessage?: unknown;
+            /** @example Smith */
+            lastName?: unknown;
+            /** @example London */
+            location?: unknown;
+            /**
+             * @example [
+             *       "5f69df13f537d14b8374a733",
+             *       "60955d000c6cf823e3f6d75a"
+             *     ]
+             */
+            mandatoryGroupIDs?: unknown;
+            /** @example +44 20 7946 0438 */
+            phoneNumber?: unknown;
+            /** @example Manager */
+            position?: unknown;
+            /** @example public@example.org */
+            publicEmailAddress?: unknown;
+            profile?: {
+                /** @example Mike */
+                firstName?: unknown;
+                /** @example Smith */
+                lastName?: unknown;
+                /** @example +44 20 7946 0438 */
+                phoneNumber?: unknown;
+                /** @example marketing@example.com */
+                publicEmailAddress?: unknown;
+                /** @example London */
+                location?: unknown;
+                /** @example Manager */
+                position?: unknown;
+                avatar?: components["schemas"]["UserAvatar"];
+                /** @example Marketing */
+                department?: unknown;
+                /** @example 1337 */
+                costcenter?: unknown;
+            };
+            recoveryCode?: {
+                /** @example 1620638653 */
+                expires?: unknown;
+                /** @example NewRecoveryCode1234 */
+                plain?: unknown;
+            };
+            role?: {
+                /** @example admin */
+                type?: unknown;
+            };
+            secret?: {
+                /** @example -1 */
+                expires?: unknown;
+                /** @example MyNewPassword1337! */
+                plain?: unknown;
+            };
+            /** @description User creation method */
+            creation?: {
+                /**
+                 * @description Creation method
+                 * @enum {string}
+                 */
+                type?: "csv" | "direct" | "sso";
+            };
+            /**
+             * @description The status of the user on the platform. The status `contact` is only applicable if you have Staffbase Email.
+             * @example pending
+             * @enum {unknown}
+             */
+            status?: "pending" | "activated" | "deactivated" | "contact";
+            /**
+             * @example [
+             *       "csv_import:newyork",
+             *       "location:NYC"
+             *     ]
+             */
+            tags?: unknown;
+            /** @example 2023-03-20T09:06:54.020Z */
+            updated?: unknown;
+            userName?: {
+                /** @example mynewusername1 */
+                value?: unknown;
+                /** @example staffbase */
+                providerID?: unknown;
+            };
+        };
+        UsersSearch: {
+            /** @description total number of members */
+            total?: number;
+            /** @description cursor to get the next data */
+            nextCursor?: string;
+            /** @description cursor to get the previous data */
+            prevCursor?: string;
+            /** @description list of members */
+            entries?: {
+                /** @description list of users */
+                data?: components["schemas"]["User"][];
+            };
+        };
+        /** @description Returns a list of manageable users. */
+        Users: {
+            /** @description cursor to get the next data */
+            nextCursor?: string;
+            /** @description cursor to get the previous data */
+            prevCursor?: string;
+            /** @description list of users */
+            entries?: components["schemas"]["User"][];
+        };
+        User: {
+            /** @description unique identifier of a user */
+            id: string;
+            config?: components["schemas"]["UserConfig"];
+            /**
+             * Format: date-time
+             * @description timestamp when the user was created
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description timestamp when the user was activated
+             */
+            activatedAt?: string;
+            /** @description external identifier for a user */
+            externalId?: string;
+            /** @description role for permission checks */
+            role?: string;
+            email?: components["schemas"]["Email"];
+            status: components["schemas"]["UserStatus"];
+            /** @description access code assigned to the user before activation */
+            secret?: string;
+            profile?: components["schemas"]["UserDataProfile"];
+            userName?: components["schemas"]["UserName"];
+        };
+        UserInvite: {
+            /** @description unique username of the user */
+            userName?: string;
+            /** @description primary mail for different functionalities like login */
+            email?: string;
+            /** @description identifier to match with interfacing systems */
+            externalId?: string;
+            /** @description permission role on the platform */
+            role: string;
+            /**
+             * @description The status of the user on the platform. Set to `contact` to create a contact account without login access. The option to set `contact` is available only if you have Staffbase Email.
+             * @enum {string}
+             */
+            status?: "pending" | "contact";
+            config: {
+                /** @description language setting for the specific user */
+                locale: string;
+            };
+            profile?: components["schemas"]["UserDataProfile"];
+        };
+        UserUpdate: {
+            /** @description primary mail for different functionalities like login */
+            email?: string;
+            /** @description permission role for the whole branch */
+            role?: string;
+            status?: components["schemas"]["UserStatus"];
+            /** @description external identifier for a user */
+            externalId?: string;
+            profile?: components["schemas"]["UserDataProfile"];
+            /** @description name of the user */
+            userName?: string;
+            recoveryCode?: components["schemas"]["Secret"];
+            /** @description value of the password or access code */
+            secret?: string;
+            /**
+             * @description This property determines if an email invitation is sent out from the Staffbase platform to the primary email address of a pending user. Only set this property to `true` when the invitation email is intended. If the user is equipped with an email you can send an email invitation to the new user by setting the *sendMail* parameter to `true`. The user receives an email to sign up for the app. <div class="sb-box sb-box--tip"> When the <span class="mdx-code">sendMail</span> parameter is not included or specified in the request, by default it is set with the value <span class="mdx-code">false</span>. If you want the email invitation to be sent out, set the <span class="mdx-code">sendMail</span> parameter with the value <span class="mdx-code">true</span>.  </div> See the <a href="/basic-concepts/user-model" target="_blank">user model</a> for more information on all available properties.
+             * @example false
+             */
+            sendMail?: boolean;
+        };
+        Secret: {
+            /** @description value of the password or access code */
+            plain?: string;
+            /** @description time when the secret is not valid anymore or 'unlimited' when there is no expiration or 'expired' if the secret is already expired */
+            expires?: string;
+        };
+        UserConfig: {
+            /**
+             * @description Content language locale for the specific user. The locale has to be one of the <a href="/references/languages-and-locale-codes/" target="_blank">supported language locales</a>. The user can <a href="https://support.staffbase.com/hc/en-us/articles/206524359-Changing-the-Language" target="_blank">update their content language</a> any time in the App or Intranet settings.
+             * @example en_US
+             */
+            locale: string;
+        };
+        UserName: {
+            /** @description unique username of the user */
+            value?: string;
+            /**
+             * @description source of the username
+             * @enum {string}
+             */
+            source: "admin" | "user" | "system";
+        };
+        Email: {
+            /** @description primary mail of the user */
+            value?: string;
+            /**
+             * @description source of the email address
+             * @enum {string}
+             */
+            source: "admin" | "user" | "system";
+        };
+        /**
+         * A single user
+         * @description A single user
+         */
+        SingleUserWithAvatarSync: {
+            /** @example 2021-07-28T06:49:15.462Z */
+            activated?: string;
+            avatar?: components["schemas"]["UserAvatar"];
+            config?: {
+                /** @example en_US */
+                locale?: string;
+            };
+            /** @example 2021-07-22T09:14:39.146Z */
+            created?: string;
+            /** @example Development & Research */
+            department?: string;
+            /**
+             * @example [
+             *       {
+             *         "value": "john@doe.com",
+             *         "primary": true,
+             *         "providerID": "staffbase"
+             *       }
+             *     ]
+             */
+            emails?: Record<string, never>[];
+            /** @example jd123 */
+            externalID?: string;
+            /** @example John */
+            firstName?: string;
+            /**
+             * @example [
+             *       "c69e7b20e6504345aa4b4938",
+             *       "9e7b20e6504dfa90a4345aa3"
+             *     ]
+             */
+            groupIDs?: unknown;
+            /** @example 20e6504df8a90a4345aa4b49 */
+            id?: string;
+            /** @example Doe */
+            lastName?: string;
+            /** @example Chemnitz */
+            location?: string;
+            /**
+             * @example [
+             *       "c69e7b20e6504345aa4b4938"
+             *     ]
+             */
+            mandatoryGroupIDs?: unknown;
+            /** @example +491234567890 */
+            phoneNumber?: string;
+            /** @example Developer */
+            position?: string;
+            profile?: {
+                avatar?: components["schemas"]["UserAvatar"];
+                /** @example Development & Research */
+                department?: string;
+                /** @example John */
+                firstName?: string;
+                /** @example Doe */
+                lastName?: string;
+                /** @example Chemnitz */
+                location?: string;
+                /** @example +491234567890 */
+                phoneNumber?: string;
+                /** @example Developer */
+                position?: string;
+                /** @example hi@example.com */
+                publicEmailAddress?: string;
+            };
+            /** @example hi@example.com */
+            publicEmailAddress?: string;
+            role?: {
+                /** @example admin */
+                type?: string;
+            };
+            /**
+             * @description This status of the user on the platform The status `contact` is only applicable if you have Staffbase Email.
+             * @example activated
+             * @enum {string}
+             */
+            status?: "pending" | "activated" | "deactivated" | "deleted" | "contact";
+            /** @example 2021-08-16T15:15:45.668 */
+            updated?: string;
+        };
+        /** @description The object that holds different types of accessor ids for a group, including user, group, and platform access. Its presence indicates that the group is open. If it is omitted, the group is internal. It is required only for open groups. */
+        GroupAccessorIds: {
+            /** @description List of user ids that has access to this group. */
+            userIds?: string[];
+            /** @description List of group ids that has access to this group. */
+            groupIds?: string[];
+            /** @description Shows whether all users on the platform have access to this group. */
+            branchAccess?: boolean;
+        };
+        /** @description The object that holds different localization values for a group. Refer to the <a href="https://developers.staffbase.com/references/languages-and-locale-codes" target="_blank" rel="noopener noreferrer">localization documentation</a> for the list of supported locales. */
+        Localization: {
+            [key: string]: {
+                /** @description Name of the group. */
+                name: string;
+                /** @description Description of the group. */
+                description?: string;
+            };
+        };
+        GroupConfig: {
+            localization: components["schemas"]["Localization"];
+            /** @description Show the group in the My Groups overview page. */
+            showInOverview: boolean;
+            /** @description URL to the group image. */
+            imageUrl?: string;
+            /** @description Icon of the group. */
+            icon?: string;
+            /** @description URL of a custom icon for the group. */
+            customIconUrl?: string;
+            /** @description URL to the group page. */
+            link?: string;
+        };
+        GroupCreator: {
+            /** @description Unique identifier of the creator. */
+            id?: string;
+            /**
+             * @description Type of the creator.
+             * @enum {string}
+             */
+            type: "integration" | "scim" | "token" | "user";
+        };
+        /** @description Defines conditions for including or excluding users from a group based on tags. */
+        Conditions: {
+            /** @description List of tags that users must match to be included or excluded. */
+            tags?: string[];
+        };
+        Group: {
+            /** @description Unique identifier of a group. */
+            id: string;
+            accessorIds?: components["schemas"]["GroupAccessorIds"];
+            adminIds?: components["schemas"]["GroupAccessorIds"];
+            /** @description External systems identifier of the group. */
+            externalId?: string;
+            config: components["schemas"]["GroupConfig"];
+            /**
+             * @description Type of the group. Learn more about <a href="https://support.staffbase.com/hc/en-us/articles/360010803979-Types-of-User-Groups" target="_blank" rel="noopener noreferrer"> types of user groups</a>.
+             * @enum {string}
+             */
+            type: "conditional" | "internal" | "open";
+            creator: components["schemas"]["GroupCreator"];
+            /**
+             * Format: date-time
+             * @description Timestamp of the last update.
+             */
+            updatedAt: string;
+            /** @description List of inclusion conditions. */
+            inclusions?: components["schemas"]["Conditions"][];
+            /** @description List of included userIds. */
+            inclusionUserIds?: string[];
+            /** @description List of exclusion conditions. */
+            exclusions?: components["schemas"]["Conditions"][];
+            /** @description List of excluded userIds. */
+            exclusionUserIds?: string[];
+        };
+        GroupsSearch: {
+            /** @description The total number of groups matching the search. */
+            total?: number;
+            /** @description Cursor to get the next data page. */
+            nextCursor?: string;
+            /** @description Cursor to get the previous data page. */
+            prevCursor?: string;
+            /** @description List of searched groups. */
+            entries?: {
+                /** @description List of groups. */
+                data?: components["schemas"]["Group"][];
+            };
+        };
+    };
+    responses: {
+        /** @description This occurs when a valid token is missing. */
+        NoToken: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                /**
+                 * @example {
+                 *       "identifier": 40102,
+                 *       "statusCode": 401,
+                 *       "message": "This endpoint requires authentication.",
+                 *       "type": "NotLoggedInException"
+                 *     }
+                 */
+                "application/json": unknown;
+            };
+        };
+        /** @description This occurs when the used token has not the required permissions to perform this action. */
+        NoPermission: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                /**
+                 * @example {
+                 *       "identifier": 40308,
+                 *       "statusCode": 403,
+                 *       "message": "Access to branch [null] is restricted. You are trying to perform an operation that exceeds the access level.",
+                 *       "type": "AccessDeniedException"
+                 *     }
+                 */
+                "application/json": unknown;
+            };
+        };
+        /** @description This occurs when the requested resource does not exist. */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                /**
+                 * @example {
+                 *       "identifier": 40408,
+                 *       "statusCode": 404,
+                 *       "message": "User '5791e3ffd4c61f21c3df8b9' could not be found.",
+                 *       "type": "NotFoundException"
+                 *     }
+                 */
+                "application/json": unknown;
+            };
+        };
+        /** @description Password recovery is not possible for this user. This happens when the user has no email address set or when the app configuration doesn't allow password recovery. */
+        NoRecovery: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description Your branch needs at least one admin. */
+        NoAdmin: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description The user has been successfully updated. */
+        UserUpdated: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                /**
+                 * @example {
+                 *       "config": {
+                 *         "locale": "en_US"
+                 *       },
+                 *       "created": "2021-02-28T09:39:44.431Z",
+                 *       "department": "Marketing",
+                 *       "emails": [
+                 *         {
+                 *           "value": "mike.smith@example.com",
+                 *           "primary": true
+                 *         }
+                 *       ],
+                 *       "externalID": "209tz9hgbrevkmfkq03j",
+                 *       "firstName": "Mike",
+                 *       "groupIDs": [],
+                 *       "id": "603b64e00c3fdb29134eb89b",
+                 *       "lastName": "Smith",
+                 *       "location": "London",
+                 *       "mandatoryGroupIDs": [
+                 *         "5f69df13f537d14b8374a733",
+                 *         "60955d000c6cf823e3f6d75a"
+                 *       ],
+                 *       "phoneNumber": "+44 20 7946 0438",
+                 *       "position": "Manager",
+                 *       "profile": {
+                 *         "firstName": "Mike",
+                 *         "lastName": "Smith",
+                 *         "phoneNumber": "+44 20 7946 0438",
+                 *         "publicEmailAddress": "public@example.org",
+                 *         "location": "London",
+                 *         "position": "Manager",
+                 *         "avatar": null,
+                 *         "department": null,
+                 *         "costcenter": "1337"
+                 *       },
+                 *       "publicEmailAddress": "public@example.org",
+                 *       "role": {
+                 *         "type": "admin"
+                 *       },
+                 *       "tags": [
+                 *         "csv_import:newyork",
+                 *         "profile:jobtype:accountant",
+                 *         "location:NYC"
+                 *       ],
+                 *       "userName": {
+                 *         "value": "john.doe",
+                 *         "providerID": "staffbase"
+                 *       },
+                 *       "status": "deactivated",
+                 *       "updated": "2021-03-02T09:39:44.441Z"
+                 *     }
+                 */
+                "application/json": unknown;
+            };
+        };
+    };
+    parameters: {
+        /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+        UserId: string;
+        /** @description A string that is used for searching in any profile field available for users, such as firstname, lastname, or location. You can combine this with the filter parameter if needed. */
+        Query: string;
+        /** @description If set to `true`, the response will also include users that have been deleted. Only users that have been deleted in the last 30 days are included. This is useful for synchronizing users with an external system. */
+        IncludeDeleted: boolean;
+        /** @description Switch to include the user profile data in the response. */
+        IncludeProfile: boolean;
+        /** @description A string as encoded cursor information to the next data page. <strong> Note:</strong> This replaces the non-performant `offset` pagination and is only available in the latest endpoint versions, not in older versions. */
+        Cursor: string;
+        /** @description A string that is used for searching groups by name. */
+        VisibleGroupsQuery: string;
+        /** @description Content filter in **SCIM notation**. You can combine this with the query parameter if needed. For more details see our guide for the <a href="/references/user-api-filters/" target="_blank">filter parameter</a>. */
+        Filter: string;
+        /** @description The amount of items that should be returned. */
+        Limit100: number;
+        /** @description The amount of items that should be returned. */
+        Limit1000: number;
+        /** @description The amount of items that should be returned. */
+        Limit: number;
+        /** @description Define an offset for getting the items starting at this number. Currently, the maximum offset is 800,000. If you need to access more than 800,000 items, please use the user sync API instead. <strong>Note</strong>: In the latest versions of some endpoints, cursor-based pagination is available instead of offset pagination for improved performance. */
+        Offset: number;
+        /** @description Sort users by a specific field. */
+        Sort: "created_ASC" | "created_DESC" | "lastName_ASC_firstName_ASC" | "updated_DESC" | "activated_DESC" | "relevance_DESC";
+        /** @description Sort groups by a specific field. */
+        UserGroupOrder: "created_DESC" | "name_ASC" | "updated_DESC";
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    GetUsers: {
+        parameters: {
+            query?: {
+                /** @description A string as encoded cursor information to the next data page. <strong> Note:</strong> This replaces the non-performant `offset` pagination and is only available in the latest endpoint versions, not in older versions. */
+                cursor?: components["parameters"]["Cursor"];
+                /** @description A string that is used for searching in any profile field available for users, such as firstname, lastname, or location. You can combine this with the filter parameter if needed. */
+                query?: components["parameters"]["Query"];
+                /** @description Content filter in **SCIM notation**. You can combine this with the query parameter if needed. For more details see our guide for the <a href="/references/user-api-filters/" target="_blank">filter parameter</a>. */
+                filter?: components["parameters"]["Filter"];
+                /** @description The amount of items that should be returned. */
+                limit?: components["parameters"]["Limit1000"];
+                /** @description Define an offset for getting the items starting at this number. Currently, the maximum offset is 800,000. If you need to access more than 800,000 items, please use the user sync API instead. <strong>Note</strong>: In the latest versions of some endpoints, cursor-based pagination is available instead of offset pagination for improved performance. */
+                offset?: components["parameters"]["Offset"];
+                /** @description Sort users by a specific field. */
+                sort?: components["parameters"]["Sort"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Get a list of users. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.staffbase.accessors.users.v2+json": components["schemas"]["Users"];
+                    "application/json": components["schemas"]["ReturnUsers"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+        };
+    };
+    InviteUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/vnd.staffbase.accessors.user-invite.v2+json": components["schemas"]["UserInvite"];
+                "application/json": components["schemas"]["CreateUser"];
+            };
+        };
+        responses: {
+            /** @description New user created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.staffbase.accessors.user.v3+json": components["schemas"]["User"];
+                    "application/json": components["schemas"]["CreateUserInMarketingResponse"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+        };
+    };
+    searchUsersOfBranch: {
+        parameters: {
+            query?: {
+                /** @description A string as encoded cursor information to the next data page. <strong> Note:</strong> This replaces the non-performant `offset` pagination and is only available in the latest endpoint versions, not in older versions. */
+                cursor?: components["parameters"]["Cursor"];
+                /** @description A string that is used for searching in any profile field available for users, such as firstname, lastname, or location. You can combine this with the filter parameter if needed. */
+                query?: components["parameters"]["Query"];
+                /** @description Content filter in **SCIM notation**. You can combine this with the query parameter if needed. For more details see our guide for the <a href="/references/user-api-filters/" target="_blank">filter parameter</a>. */
+                filter?: components["parameters"]["Filter"];
+                /** @description Sort users by a specific field. */
+                sort?: components["parameters"]["Sort"];
+                /** @description The amount of items that should be returned. */
+                limit?: components["parameters"]["Limit"];
+                /** @description Switch to include the user profile data in the response. */
+                includeProfile?: components["parameters"]["IncludeProfile"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Get a list of users that match the given search filters. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.staffbase.accessors.users-search.v1+json": components["schemas"]["UsersSearch"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+        };
+    };
+    GetSpecificUser: {
+        parameters: {
+            query?: {
+                /** @description Switch to include the user profile data in the response. */
+                includeProfile?: components["parameters"]["IncludeProfile"];
+            };
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Get a single user by the identifier. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.staffbase.accessors.user.v3+json": components["schemas"]["User"];
+                    "application/json": components["schemas"]["SingleUserWithAvatar"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    UpdateUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdateUser"];
+            };
+        };
+        responses: {
+            200: components["responses"]["UserUpdated"];
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    DeleteUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description This is the legacy response. Switch to new version. The user has been successfully removed from the platform. The status code is returned without a payload. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+            /** @description User deleted. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.staffbase.accessors.user-delete.v2+json": unknown;
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+            404: components["responses"]["NotFound"];
+            405: components["responses"]["NoAdmin"];
+        };
+    };
+    updateUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/vnd.staffbase.accessors.user-update.v1+json": components["schemas"]["UserUpdate"];
+            };
+        };
+        responses: {
+            /** @description User updated */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.staffbase.accessors.user.v3+json": components["schemas"]["User"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    GetGroupsOfUser: {
+        parameters: {
+            query?: {
+                /** @description The amount of items that should be returned. */
+                limit?: components["parameters"]["Limit100"];
+                /** @description Define an offset for getting the items starting at this number. Currently, the maximum offset is 800,000. If you need to access more than 800,000 items, please use the user sync API instead. <strong>Note</strong>: In the latest versions of some endpoints, cursor-based pagination is available instead of offset pagination for improved performance. */
+                offset?: components["parameters"]["Offset"];
+                /** @description Sort groups by a specific field. */
+                sort?: components["parameters"]["UserGroupOrder"];
+            };
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns a list of groups. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReturnGroups"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    GetUserGroups: {
+        parameters: {
+            query?: {
+                /** @description A string as encoded cursor information to the next data page. <strong> Note:</strong> This replaces the non-performant `offset` pagination and is only available in the latest endpoint versions, not in older versions. */
+                cursor?: components["parameters"]["Cursor"];
+                /** @description A string that is used for searching in any profile field available for users, such as firstname, lastname, or location. You can combine this with the filter parameter if needed. */
+                query?: components["parameters"]["Query"];
+                /** @description The amount of items that should be returned. */
+                limit?: components["parameters"]["Limit"];
+            };
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Get the groups of a user. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.staffbase.accessors.user.groups-search.v1+json": components["schemas"]["GroupsSearch"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    GetVisibleGroupsOfUser: {
+        parameters: {
+            query?: {
+                /** @description A string that is used for searching groups by name. */
+                query?: components["parameters"]["VisibleGroupsQuery"];
+                /** @description The amount of items that should be returned. */
+                limit?: components["parameters"]["Limit100"];
+                /** @description Define an offset for getting the items starting at this number. Currently, the maximum offset is 800,000. If you need to access more than 800,000 items, please use the user sync API instead. <strong>Note</strong>: In the latest versions of some endpoints, cursor-based pagination is available instead of offset pagination for improved performance. */
+                offset?: components["parameters"]["Offset"];
+                /** @description Sort groups by a specific field. */
+                sort?: components["parameters"]["UserGroupOrder"];
+            };
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns a list of groups, that are visible to the user. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReturnGroups"];
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    UserRecovery: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The recovery mail was successfully sent to the user. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["NoRecovery"];
+            401: components["responses"]["NoToken"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    DeleteUserSessions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier automatically generated by the Staffbase platform or the externalID, if it is added for the user. */
+                userId: components["parameters"]["UserId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The user has been successfully logged out of all active sessions. The status code is returned without a payload. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    Sync: {
+        parameters: {
+            query?: {
+                /** @description A string as encoded cursor information to the next data page. <strong> Note:</strong> This replaces the non-performant `offset` pagination and is only available in the latest endpoint versions, not in older versions. */
+                cursor?: components["parameters"]["Cursor"];
+                /** @description If set to `true`, the response will also include users that have been deleted. Only users that have been deleted in the last 30 days are included. This is useful for synchronizing users with an external system. */
+                includeDelete?: components["parameters"]["IncludeDeleted"];
+                /** @description The amount of items that should be returned. */
+                limit?: components["parameters"]["Limit1000"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A list of user records with pagination links */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data?: components["schemas"]["SingleUserWithAvatarSync"][];
+                        links?: {
+                            next?: {
+                                /** @example GET */
+                                method?: string;
+                                /**
+                                 * Format: uri
+                                 * @example https://example.staffbase.com/api/users/sync/
+                                 */
+                                resource?: string;
+                                params?: {
+                                    /** @example 3 */
+                                    limit?: number;
+                                    /** @example MTY2Mzg0ODAzNDA5Mw==__NjMyYzRlNjEzZTYzYTkxOTA4MGNlOTQx__dHJ1ZQ== */
+                                    cursor?: string;
+                                    /** @example false */
+                                    includeDelete?: boolean;
+                                };
+                                /**
+                                 * Format: uri
+                                 * @example https://example.staffbase.com/api/users/sync?limit=3&cursor=MTY2Mzg0ODAzNDA5Mw%3D%3D__NjMyYzRlNjEzZTYzYTkxOTA4MGNlOTQx__dHJ1ZQ%3D%3D&includeDelete=false
+                                 */
+                                href?: string;
+                            };
+                        };
+                    };
+                };
+            };
+            401: components["responses"]["NoToken"];
+            403: components["responses"]["NoPermission"];
+        };
+    };
+}
+//# sourceMappingURL=userApi.d.ts.map