@coderabbitai/bitbucket

/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { readonly "/access-tokens/latest/projects/{projectKey}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get project HTTP tokens * @description Get all access tokens associated with the given project. */ readonly get: operations["getAllAccessTokens"]; /** * Create project HTTP token * @description Create an access token for the project according to the given request. */ readonly put: operations["createAccessToken"]; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/access-tokens/latest/projects/{projectKey}/{tokenId}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get HTTP token by ID * @description Get the access token identified by the given ID. */ readonly get: operations["getById"]; readonly put?: never; /** * Update HTTP token * @description Modify an access token according to the given request. Any fields not specified will not be altered. */ readonly post: operations["updateAccessToken"]; /** * Delete a HTTP token * @description Delete the access token identified by the given ID. */ readonly delete: operations["deleteById"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get repository HTTP tokens * @description Get all access tokens associated with the given repository. */ readonly get: operations["getAllAccessTokens_1"]; /** * Create repository HTTP token * @description Create an access token for the repository according to the given request. */ readonly put: operations["createAccessToken_1"]; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}/{tokenId}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get HTTP token by ID * @description Get the access token identified by the given ID. */ readonly get: operations["getById_1"]; readonly put?: never; /** * Update HTTP token * @description Modify an access token according to the given request. Any fields not specified will not be altered. */ readonly post: operations["updateAccessToken_1"]; /** * Delete a HTTP token * @description Delete the access token identified by the given ID. */ readonly delete: operations["deleteById_1"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/access-tokens/latest/users/{userSlug}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get personal HTTP tokens * @description Get all access tokens associated with the given user. */ readonly get: operations["getAllAccessTokens_2"]; /** * Create personal HTTP token * @description Create an access token for the user according to the given request. */ readonly put: operations["createAccessToken_2"]; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/access-tokens/latest/users/{userSlug}/{tokenId}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get HTTP token by ID * @description Get the access token identified by the given ID. */ readonly get: operations["getById_2"]; readonly put?: never; /** * Update HTTP token * @description Modify an access token according to the given request. Any fields not specified will not be altered. */ readonly post: operations["updateAccessToken_2"]; /** * Delete a HTTP token * @description Delete the access token identified by the given ID. */ readonly delete: operations["deleteById_2"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/admin": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get global SSH key settings * @description Gets the global settings that enforce the maximum expiry of SSH keys and restrictions on SSH key types. */ readonly get: operations["getGlobalSettings"]; /** * Update global SSH key settings * @description Updates the global settings that enforces the maximum expiry of SSH keys and restrictions on SSH key types. */ readonly put: operations["updateGlobalSettings"]; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/admin/supported-key-types": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get supported SSH key algorithms and lengths * @description Retrieves a list of all supported SSH key algorithms and lengths. */ readonly get: operations["getSupportedKeyTypes"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/banner": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get announcement banner * @description Gets the announcement banner, if one exists and is available to the user */ readonly get: operations["getBanner"]; /** * Update/Set announcement banner * @description Sets the announcement banner with the provided JSON. * Only users authenticated as Admins may call this resource */ readonly put: operations["setBanner"]; readonly post?: never; /** * Delete announcement banner * @description Deletes a banner, if one is present in the database. */ readonly delete: operations["deleteBanner"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/cluster": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get cluster node information * @description Gets information about the nodes that currently make up the stash cluster. * * The authenticated user must have the SYS_ADMIN permission to call this resource. */ readonly get: operations["getInformation"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/default-branch": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get the default branch * @description Retrieves the configured global default branch, which is used when creating new repositories if an explicit default branch is not specified. * * The user must be authenticated to call this resource. */ readonly get: operations["getDefaultBranch"]; /** * Update/Set default branch * @description Configures the global default branch, which is used when creating new repositories if an explicit default branch is not specified. * * The authenticated user must have ADMIN permission to call this resource. */ readonly put: operations["setDefaultBranch"]; readonly post?: never; /** * Clear default branch * @description Clears the global default branch, which is used when creating new repositories if an explicit default branch is not specified, if one has been configured. * * The authenticated user must have ADMIN permission to call this resource. */ readonly delete: operations["clearDefaultBranch"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/git/mesh/config/control-plane.pem": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get the control plane PEM * @description Obtain the control plane PEM. * * The authenticated user must have **SYS_ADMIN** permission. */ readonly get: operations["getControlPlanePublicKey"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/git/mesh/diagnostics/connectivity": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Generate Mesh connectivity report * @description Generates a connectivity report between the Bitbucket node(s) and the Mesh node(s). * * The authenticated user must have **SYS_ADMIN** permission. */ readonly get: operations["connectivity"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/git/mesh/nodes": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get all registered Mesh nodes * @description Get all the registered Mesh nodes. * * The authenticated user must have **SYS_ADMIN** permission. */ readonly get: operations["getAllRegisteredMeshNodes"]; readonly put?: never; /** * Register new Mesh node * @description Register a new Mesh node. * * The authenticated user must have **SYS_ADMIN** permission. */ readonly post: operations["registerNewMeshNode"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/git/mesh/nodes/{id}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get Mesh node * @description Get the registered Mesh node that matches the supplied ID. * * The authenticated user must have **SYS_ADMIN** permission. */ readonly get: operations["getRegisteredMeshNodeById"]; /** * Update Mesh node * @description Update a Mesh node. * * The authenticated user must have **SYS_ADMIN** permission. */ readonly put: operations["updateMeshNode"]; readonly post?: never; /** * Delete Mesh node * @description Delete a Mesh node * * The authenticated user must have **SYS_ADMIN** permission. */ readonly delete: operations["delete_2"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/git/mesh/support-zips": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get support zips for all Mesh nodes * @description Get the support zips for all the Mesh nodes. * * The authenticated user must have **SYS_ADMIN** permission. */ readonly get: operations["getSupportZips"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/git/mesh/support-zips/{id}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get support zip for node * @description Get the support zip for the Mesh node that matches the specified ID. * * The authenticated user must have **SYS_ADMIN** permission. */ readonly get: operations["getSupportZip"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/groups": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get groups * @description Retrieve a page of groups. * * The authenticated user must have LICENSED_USER permission or higher to call this resource. */ readonly get: operations["getGroups_1"]; readonly put?: never; /** * Create group * @description Create a new group. * * The authenticated user must have ADMIN permission or higher to call this resource. */ readonly post: operations["createGroup"]; /** * Remove group * @description Deletes the specified group, removing them from the system. This also removes any permissions that may have been granted to the group. * * A user may not delete the last group that is granting them administrative permissions, or a group with greater permissions than themselves. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly delete: operations["deleteGroup"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/groups/add-user": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; /** * Add user to group * @deprecated * @description Deprecated since 2.10. Use /rest/users/add-groups instead. * * Add a user to a group. * * In the request entity, the context attribute is the group and the itemName is the user. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly post: operations["addUserToGroup"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/groups/add-users": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; /** * Add multiple users to group * @description Add multiple users to a group. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly post: operations["addUsersToGroup"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/groups/more-members": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get group members * @description Retrieves a list of users that are members of a specified group. The authenticated user must have the LICENSED_USER permission to call this resource. */ readonly get: operations["findUsersInGroup"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/groups/more-non-members": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get members not in group * @description Retrieves a list of users that are not members of a specified group. The authenticated user must have the LICENSED_USER permission to call this resource. */ readonly get: operations["findUsersNotInGroup"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/groups/remove-user": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; /** * Remove user from group * @deprecated * @description Deprecated since 2.10. Use /rest/users/remove-groups instead. * * Remove a user from a group. * * The authenticated user must have the ADMIN permission to call this resource. * * In the request entity, the context attribute is the group and the itemName is the user. */ readonly post: operations["removeUserFromGroup"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/license": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get license details * @description Retrieves details about the current license, as well as the current status of the system with regards to the installed license. The status includes the current number of users applied toward the license limit, as well as any status messages about the license (warnings about expiry or user counts exceeding license limits). * * The authenticated user must have ADMIN permission. Unauthenticated users, and non-administrators, are not permitted to access license details. */ readonly get: operations["get_2"]; readonly put?: never; /** * Update license * @description Decodes the provided encoded license and sets it as the active license. If no license was provided, a 400 is returned. If the license cannot be decoded, or cannot be applied, a 409 is returned. Some possible reasons a license may not be applied include: * * - It is for a different product * - It is already expired * * * Otherwise, if the license is updated successfully, details for the new license are returned with a 200 response. * * Warning: It is possible to downgrade the license during update, applying a license with a lower number of permitted users. If the number of currently-licensed users exceeds the limits of the new license, pushing will be disabled until the licensed user count is brought into compliance with the new license. * * The authenticated user must have SYS_ADMIN permission. ADMIN users may view the current license details, but they may not update the license. */ readonly post: operations["updateLicense"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/mail-server": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get mail configuration * @description Retrieves the current mail configuration. * * The authenticated user must have the SYS_ADMIN permission to call this resource. */ readonly get: operations["getMailConfig"]; /** * Update mail configuration * @description Updates the mail configuration. * * The authenticated user must have the SYS_ADMIN permission to call this resource. */ readonly put: operations["setMailConfig"]; readonly post?: never; /** * Delete mail configuration * @description Deletes the current mail configuration. * * The authenticated user must have the SYS_ADMIN permission to call this resource. */ readonly delete: operations["deleteMailConfig"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/mail-server/sender-address": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get server mail address * @description Retrieves the server email address */ readonly get: operations["getSenderAddress"]; /** * Update server mail address * @description Updates the server email address * * The authenticated user must have the ADMIN permission to call this resource. */ readonly put: operations["setSenderAddress"]; readonly post?: never; /** * Update mail configuration * @description Clears the server email address. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly delete: operations["clearSenderAddress"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/permissions/groups": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get groups with a global permission * @description Retrieve a page of groups that have been granted at least one global permission. * * * The authenticated user must have ADMIN permission or higher to call this resource. */ readonly get: operations["getGroupsWithAnyPermission"]; /** * Update global permission for group * @description Promote or demote a group's global permission level. Available global permissions are: * * * - LICENSED_USER * - PROJECT_CREATE * - ADMIN * - SYS_ADMIN * * See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Global+permissions">Bitbucket Data Center documentation</a> for a detailed explanation of what each permission entails. * * * The authenticated user must have: * * * - ADMIN permission or higher; and * - the permission they are attempting to grant or higher; and * - greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them) * * * to call this resource. In addition, a user may not demote a group's permission level if their own permission * level would be reduced as a result. */ readonly put: operations["setPermissionForGroups"]; readonly post?: never; /** * Revoke all global permissions for group * @description Revoke all global permissions for a group. * * * * The authenticated user must have: * * * - ADMIN permission or higher; and * - greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them) * * * to call this resource. In addition, a user may not revoke a group's permissions if their own permission level * would be reduced as a result. */ readonly delete: operations["revokePermissionsForGroup"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/permissions/groups/none": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get groups with no global permission * @description Retrieve a page of groups that have no granted global permissions. * * * The authenticated user must have ADMIN permission or higher to call this resource. */ readonly get: operations["getGroupsWithoutAnyPermission"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/permissions/users": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get users with a global permission * @description Retrieve a page of users that have been granted at least one global permission. * * * The authenticated user must have ADMIN permission or higher to call this resource. */ readonly get: operations["getUsersWithAnyPermission"]; /** * Update global permission for user * @description Promote or demote the global permission level of a user. Available global permissions are: * * * - LICENSED_USER * - PROJECT_CREATE * - ADMIN * - SYS_ADMIN * * * See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Global+permissions">Bitbucket Data Center documentation</a> for a detailed explanation of what each permission entails. * * * The authenticated user must have: * * * - ADMIN permission or higher; and * - the permission they are attempting to grant; and * - greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them) * * * to call this resource. In addition, a user may not demote their own permission level. */ readonly put: operations["setPermissionForUsers"]; readonly post?: never; /** * Revoke all global permissions for user * @description Revoke all global permissions for a user. * * * The authenticated user must have: * * * - ADMIN permission or higher; and * - greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them) * * * to call this resource. In addition, a user may not demote their own permission level. */ readonly delete: operations["revokePermissionsForUser"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/permissions/users/none": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get users with no global permission * @description Retrieve a page of users that have no granted global permissions. * * * The authenticated user must have ADMIN permission or higher to call this resource. */ readonly get: operations["getUsersWithoutAnyPermission"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/pull-requests/{scmId}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get merge strategies * @description Retrieve the merge strategies available for this instance. * * The user must be authenticated to call this resource. */ readonly get: operations["getMergeConfig"]; readonly put?: never; /** * Update merge strategies * @description Update the pull request merge strategies for the context repository. * * The authenticated user must have ADMIN permission to call this resource. * * Only the strategies provided will be enabled, only one may be set to default * * The commit message template will not be updated if not provided, and will be deleted if the `commitMessageTemplate` attribute is empty, i.e: `commitMessageTemplate: {}`. * * An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty `mergeConfig` attribute. i.e: * ``` * { * "mergeConfig": {} * } * ``` * * Upon completion of this request, the effective configuration will be the default configuration. */ readonly post: operations["setMergeConfig"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/rate-limit/history": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get rate limit history * @description Retrieves the recent rate limit history for the instance. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly get: operations["getHistory"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/rate-limit/settings": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get rate limit settings * @description Retrieves the rate limit settings for the instance. * * The user must be authenticated to call this resource. */ readonly get: operations["getSettings_2"]; /** * Set rate limit * @description Sets the rate limit settings for the instance. * * The authenticated user must have ADMIN permission to call this resource. */ readonly put: operations["setSettings_2"]; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/rate-limit/settings/users": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get rate limit settings for user * @description Retrieves the user-specific rate limit settings for the given user. * * The authenticated user must have ADMIN permission to call this resource. */ readonly get: operations["getAllRateLimitSettings"]; readonly put?: never; /** * Set rate limit settings for users * @description Sets the given rate limit settings for the given users. * * The authenticated user must have ADMIN permission to call this resource. */ readonly post: operations["set_2"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/rate-limit/settings/users/{userSlug}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get user specific rate limit settings * @description Retrieves the user-specific rate limit settings for the given user. * * To call this resource, the user must be authenticated and either have ADMIN permission or be the same user as the one whose settings are requested. A user with ADMIN permission cannot get the settings of a user with SYS_ADMIN permission. */ readonly get: operations["get_6"]; /** * Set rate limit settings for user * @description Sets the given rate limit settings for the given user. * * The authenticated user must have ADMIN permission to call this resource. */ readonly put: operations["set_3"]; readonly post?: never; /** * Delete user specific rate limit settings * @description Deletes the user-specific rate limit settings for the given user. * * The authenticated user must have ADMIN permission to call this resource. */ readonly delete: operations["delete_8"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/user-directories": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get directories * @description Retrieve a list of active directories. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly get: operations["getUserDirectories"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get users * @description Retrieve a page of users. * * The authenticated user must have the LICENSED_USER permission to call this resource. */ readonly get: operations["getUsers_1"]; /** * Update user details * @description Update a user's details. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly put: operations["updateUserDetails"]; /** * Create user * @description Creates a new user from the assembled query parameters. * * The default group can be used to control initial permissions for new users, such as granting users the ability to login or providing read access to certain projects or repositories. If the user is not added to the default group, they may not be able to login after their account is created until explicit permissions are configured. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly post: operations["createUser"]; /** * Remove user * @description Deletes the specified user, removing them from the system. This also removes any permissions that may have been granted to the user. * * A user may not delete themselves, and a user with ADMIN permissions may not delete a user with SYS_ADMINpermissions. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly delete: operations["deleteUser"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/add-group": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; /** * Add user to group * @deprecated * @description Deprecated since 2.10. Use /rest/users/add-groups instead. * * Add a user to a group. This is very similar to <code>groups/add-user</code>, but with the context and itemName attributes of the supplied request entity reversed. On the face of it this may appear redundant, but it facilitates a specific UI component in the application. * * In the request entity, the context attribute is the user and the itemName is the group. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly post: operations["addGroupToUser"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/add-groups": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; /** * Add user to groups * @description Add a user to one or more groups. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly post: operations["addUserToGroups"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/captcha": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; readonly put?: never; readonly post?: never; /** * Clear CAPTCHA for user * @description Clears any CAPTCHA challenge that may constrain the user with the supplied username when they authenticate. Additionally any counter or metric that contributed towards the user being issued the CAPTCHA challenge (for instance too many consecutive failed logins) will also be reset. * * The authenticated user must have the ADMIN permission to call this resource, and may not clear the CAPTCHA of a user with greater permissions than themselves. */ readonly delete: operations["clearUserCaptchaChallenge"]; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/credentials": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; readonly get?: never; /** * Set password for user * @description Update a user's password. * * The authenticated user must have the ADMIN permission to call this resource, and may not update the password of a user with greater permissions than themselves. */ readonly put: operations["updateUserPassword"]; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/erasure": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Check user removal * @description Validate if a user can be erased. * * A username is only valid for erasure if it exists as the username of a deleted user. This endpoint will return an appropriate error response if the supplied username is invalid for erasure. * * This endpoint does not perform the actual user erasure, and will not modify the application in any way. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly get: operations["validateErasable"]; readonly put?: never; /** * Erase user information * @description Erases personally identifying user data for a deleted user. * * References in the application to the original username will be either removed or updated to a new non-identifying username. Refer to the <a href="https://confluence.atlassian.com/gdpr/bitbucket-right-to-erasure-949770560.html">support guide</a> for details about what data is and isn't erased. * * User erasure can only be performed on a deleted user. If the user has not been deleted first then this endpoint will return a bad request and no erasure will be performed. * * Erasing user data is irreversible and may lead to a degraded user experience. This method should not be used as part of a standard user deletion and cleanup process. * * Plugins can participate in user erasure by defining a <code><user-erasure-handler></code> module. If one or more plugin modules fail, an error summary of the failing modules is returned. * * The authenticated user must have the ADMIN permission to call this resource. */ readonly post: operations["eraseUser"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/more-members": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get groups for user * @description Retrieves a list of users that are not members of a specified group. The authenticated user must have the LICENSED_USER permission to call this resource. */ readonly get: operations["findGroupsForUser"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/more-non-members": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /**