{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Workspaces API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "Atlassian List Workspaces for the Current User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/user/permissions/workspaces", "params": [ { "name": "q", "value": "", "type": "query", "description": "\nQuery string to narrow down the response. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details." }, { "name": "sort", "value": "", "type": "query", "description": "\nName of a response property to sort results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)\nfor details.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves a list of workspaces that the currently authenticated user has permissions to access in Atlassian Bitbucket. By making a GET request to the /user/permissions/workspaces endpoint, developers can programmatically discover which workspaces are available to the authenticated user based on their account permissions and access rights. This is particularly useful for applications that need to dynamically populate workspace selection interfaces, validate user access before p" }, { "info": { "name": "Atlassian Get a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves detailed information about a specific workspace by making a GET request to the endpoint /workspaces/{workspace}, where {workspace} is a path parameter representing the unique identifier of the workspace you want to access. When executed, it returns the complete data and configuration settings associated with that particular workspace, allowing users or applications to view workspace properties, metadata, and current state information without making any modifications " }, { "info": { "name": "Atlassian List Webhooks for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/hooks", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves a paginated list of all webhooks that have been configured for a specific Bitbucket workspace. By making a GET request to the /workspaces/{workspace}/hooks endpoint with the workspace identifier, users can view all webhook subscriptions associated with that workspace, including details about the webhook URLs, events they're subscribed to, and their current status. This is useful for auditing, managing, or discovering existing webhook integrations that send HTTP callb" }, { "info": { "name": "Atlassian Create a Webhook for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/workspaces/:workspace/hooks", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation creates a new webhook for a specified Bitbucket workspace by sending a POST request to the /workspaces/{workspace}/hooks endpoint. Webhooks allow workspaces to receive real-time HTTP callbacks when specific events occur within the workspace, such as repository pushes, pull requests, or issue updates. The workspace is identified by the {workspace} path parameter, which represents the workspace ID or slug. The request typically requires authentication and a JSON payload containi" }, { "info": { "name": "Atlassian Get a webhook for a workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/hooks/:uid", "params": [ { "name": "uid", "value": "", "type": "path", "description": "Installed webhook's ID" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the webhook with the specified id installed on the given\nworkspace." }, { "info": { "name": "Atlassian Update a Webhook for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/workspaces/:workspace/hooks/:uid", "params": [ { "name": "uid", "value": "", "type": "path", "description": "Installed webhook's ID" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This operation updates an existing webhook configuration for a specified Bitbucket workspace by making a PUT request to the endpoint with the workspace slug and webhook unique identifier (uid) in the path. It allows you to modify webhook settings such as the URL that receives the webhook payloads, the events that trigger the webhook, whether the webhook is active or inactive, and other configuration options like description and secret tokens for payload verification. The request requires authent" }, { "info": { "name": "Atlassian Delete a Webhook for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/workspaces/:workspace/hooks/:uid", "params": [ { "name": "uid", "value": "", "type": "path", "description": "Installed webhook's ID" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The DELETE operation on the /workspaces/{workspace}/hooks/{uid} endpoint in the Atlassian Bitbucket Workspaces API removes a specific webhook from a workspace. This endpoint requires two path parameters: the workspace identifier and the unique identifier (uid) of the webhook to be deleted. When executed successfully, it permanently removes the webhook configuration, stopping all future webhook event notifications from being sent to the previously configured URL for that workspace. This operation" }, { "info": { "name": "Atlassian List Users in a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/members", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint retrieves a list of all members who belong to a specified Atlassian Bitbucket workspace by making a GET request to /workspaces/{workspace}/members, where {workspace} is replaced with the unique identifier or slug of the target workspace. The operation returns member details including user information, roles, and permissions for each member associated with the workspace, allowing administrators and authorized users to view and manage workspace membership. This is particularly us" }, { "info": { "name": "Atlassian Get User Membership for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/members/:member", "params": [ { "name": "member", "value": "", "type": "path", "description": "Member's UUID or Atlassian ID." }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation retrieves detailed information about a specific user's membership within a designated Bitbucket workspace. By providing the workspace identifier and member identifier in the URL path parameters, the API returns the membership details for that particular user, including their role, permissions, and associated account information within the context of the specified workspace. This endpoint is useful for administrators and applications that need to verify a user's access level, c" }, { "info": { "name": "Atlassian List User Permissions in a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/permissions", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "name": "q", "value": "", "type": "query", "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves a list of user permissions configured within a specific Bitbucket workspace by making a GET request to the /workspaces/{workspace}/permissions endpoint, where {workspace} is the unique identifier or slug of the target workspace. It returns detailed information about which users have been granted access to the workspace and their corresponding permission levels, such as member, admin, or collaborator roles. This endpoint is useful for workspace administrators who need" }, { "info": { "name": "Atlassian List All Repository Permissions for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/permissions/repositories", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "name": "q", "value": "", "type": "query", "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, { "name": "sort", "value": "", "type": "query", "description": "\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation retrieves a comprehensive list of all repository permissions configured within a specific Bitbucket workspace. By targeting the /workspaces/{workspace}/permissions/repositories endpoint, it returns permission details for repositories in the specified workspace, allowing administrators and authorized users to audit access controls and understand who has what level of access (read, write, admin) to repositories. The {workspace} path parameter identifies the target workspace, and" }, { "info": { "name": "Atlassian List a Repository Permissions for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/permissions/repositories/:repo_slug", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "name": "q", "value": "", "type": "query", "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, { "name": "sort", "value": "", "type": "query", "description": "\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint retrieves the permission settings for a specific repository within an Atlassian Bitbucket workspace. By making a GET request to this endpoint with the workspace identifier and repository slug as path parameters, users can view all the permissions that have been granted for that particular repository, including which users or groups have access and their respective permission levels (such as read, write, or admin). This is useful for workspace administrators who need to audit re" }, { "info": { "name": "Atlassian List Variables for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/variables", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves all pipeline variables configured at the workspace level in Bitbucket. By making a GET request to the specified endpoint with a workspace identifier, developers can access a list of environment variables that are available to all pipelines within that workspace, including both secured and non-secured variables along with their keys, values (for non-secured variables), and associated metadata. This is useful for managing and auditing centralized configuration settings" }, { "info": { "name": "Atlassian Create a Variable for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/variables", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The POST operation on the /workspaces/{workspace}/pipelines-config/variables endpoint allows you to create a new pipeline variable within a specific Bitbucket workspace, enabling you to define configuration values that can be used across multiple pipelines in that workspace. This endpoint requires you to specify the workspace slug in the path parameter and provide the variable details in the request body, typically including the variable's key (name), value, and whether it should be secured/encr" }, { "info": { "name": "Atlassian Get Variable for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/variables/:variable_uuid", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "variable_uuid", "value": "", "type": "path", "description": "The UUID of the variable to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves detailed information about a specific pipeline variable configured for a Bitbucket workspace by providing the workspace identifier and the unique UUID of the variable. It allows developers to programmatically access the configuration details of environment variables, secrets, or other pipeline variables that have been set up at the workspace level, which can be used across multiple repositories within that workspace. The endpoint returns the variable's metadata inclu" }, { "info": { "name": "Atlassian Update Variable for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/variables/:variable_uuid", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "variable_uuid", "value": "", "type": "path", "description": "The UUID of the variable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing pipeline variable in a Bitbucket workspace by providing the variable's UUID. This operation allows you to modify the value, security settings, or other properties of a workspace-level pipeline variable that can be used across all repositories within the workspace. The variable UUID must be provided in the path, and the updated variable configuration is sent in the request body. Workspace pipeline variables are commonly used to store shared configuration values, credentials, o" }, { "info": { "name": "Atlassian Delete a Variable for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/variables/:variable_uuid", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "variable_uuid", "value": "", "type": "path", "description": "The UUID of the variable to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to delete a specific pipeline variable from an Atlassian Bitbucket workspace by making a DELETE request to the endpoint with the workspace identifier and the unique UUID of the variable you wish to remove. Pipeline variables are typically used to store configuration values, secrets, or environment-specific settings that are used during the execution of Bitbucket Pipelines, and removing a variable through this endpoint will permanently delete it from the workspace's " }, { "info": { "name": "Atlassian List Projects in a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves a paginated list of all projects within a specified Bitbucket workspace, where the workspace is identified by its slug in the URL path. It returns project information including project keys, names, descriptions, and other metadata associated with each project that the authenticated user has permission to view. The response follows Bitbucket's standard pagination format, allowing clients to navigate through large result sets using page parameters, making it useful for" }, { "info": { "name": "Atlassian Create a Project in a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/workspaces/:workspace/projects", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation creates a new project within a specified Bitbucket workspace by sending a POST request to the /workspaces/{workspace}/projects endpoint, where {workspace} is replaced with the unique identifier or slug of the target workspace. The operation allows workspace administrators to programmatically establish new projects that serve as containers for organizing related repositories, enabling better code management and team collaboration. When invoked, the endpoint accepts project deta" }, { "info": { "name": "Atlassian Get a Project for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Get A Project For A Workspace operation in the Atlassian Bitbucket Workspaces API retrieves detailed information about a specific project within a designated workspace by making a GET request to the endpoint /workspaces/{workspace}/projects/{project_key}. This operation requires two path parameters: the workspace identifier (which can be the workspace's UUID, ID, or slug) and the project_key (a unique identifier for the project within that workspace). When successfully invoked, it returns co" }, { "info": { "name": "Atlassian Update a Project for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to update an existing project within a specified Bitbucket workspace by making a PUT request to the endpoint with the workspace slug and project key as path parameters. You can modify various project properties such as the project name, description, avatar, and other configurable settings. The request requires appropriate authentication and permissions to modify projects within the workspace, typically requiring admin or write access. Upon successful execution, the " }, { "info": { "name": "Atlassian Delete a Project for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The delete operation on the `/workspaces/{workspace}/projects/{project_key}` endpoint in the Atlassian Bitbucket Workspaces API permanently removes a specified project from a workspace. This operation requires authentication and appropriate permissions to delete projects within the designated workspace. When executed, it takes two path parameters: the workspace identifier and the project key that uniquely identifies the project to be deleted. Upon successful deletion, the project and its associa" }, { "info": { "name": "Atlassian Search for Code in a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/search/code", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "The workspace to search in; either the slug or the UUID in curly braces" }, { "name": "search_query", "value": "", "type": "query", "description": "The search query" }, { "name": "page", "value": "", "type": "query", "description": "Which page of the search results to retrieve" }, { "name": "pagelen", "value": "", "type": "query", "description": "How many search results to retrieve per page" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET endpoint allows you to search for code across repositories within a specified Atlassian Bitbucket workspace. By providing the workspace identifier in the path parameter, you can perform code searches using query parameters to find specific strings, patterns, or code snippets across all accessible repositories in that workspace. The operation returns matching results that include file paths, repository information, and code context where the search terms appear, making it useful for deve" }, { "info": { "name": "Atlassian Get OpenID configuration for OIDC in Pipelines", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/identity/oidc/.well-known/openid-configuration", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/" }, { "info": { "name": "Atlassian Get keys for OIDC in Pipelines", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/identity/oidc/keys.json", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/" }, { "info": { "name": "Atlassian Get the branching model for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the branching model set at the project level. This view is\nread-only. The branching model settings can be changed using the\n[settings](#api-workspaces-workspace-projects-project-key-branching-model-settings-get)\nAPI.\n\nThe returned object:\n\n1. Always has a `development` property. `development.name` is\n the user-specified branch that can be inherited by an individual repository's\n branching model.\n2. Might have a `production` property. `production` will not\n be present when `productio" }, { "info": { "name": "Atlassian Get the branching model config for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model/settings", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the branching model configuration for a project. The returned\nobject:\n\n1. Always has a `development` property for the development branch.\n2. Always a `production` property for the production branch. The\n production branch can be disabled.\n3. The `branch_types` contains all the branch types.\n\n\nThis is the raw configuration for the branching model. A client\nwishing to see the branching model with its actual current branches may find the\n[active model API](#api-workspaces-workspace-project" }, { "info": { "name": "Atlassian Update the branching model config for a project", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model/settings", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the branching model configuration for a project.\n\nThe `development` branch can be configured to a specific branch or to\ntrack the main branch. Any branch name can be supplied, but will only\nsuccessfully be applied to a repository via inheritance if that branch\nexists for that repository. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`development` property will leave the development branch unchanged.\n\nThe `production` bran" }, { "info": { "name": "Atlassian List the default reviewers in a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return a list of all default reviewers for a project. This is a list of users that will be added as default\nreviewers to pull requests for any repository within the project." }, { "info": { "name": "Atlassian Get a default reviewer", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers/:selected_user", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).\n" }, { "name": "selected_user", "value": "", "type": "path", "description": "This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the specified default reviewer." }, { "info": { "name": "Atlassian Add the specific user as a default reviewer for the project", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers/:selected_user", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).\n" }, { "name": "selected_user", "value": "", "type": "path", "description": "This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds the specified user to the project's list of default reviewers. The method is\nidempotent. Accepts an optional body containing the `uuid` of the user to be added." }, { "info": { "name": "Atlassian Remove the specific user from the project's default reviewers", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers/:selected_user", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).\n" }, { "name": "selected_user", "value": "", "type": "path", "description": "This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes a default reviewer from the project.\n\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/.../default-reviewers/%7Bf0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6%7D\n\nHTTP/1.1 204\n```" }, { "info": { "name": "Atlassian List project deploy keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/deploy-keys", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all deploy keys belonging to a project." }, { "info": { "name": "Atlassian Create a project deploy key", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/deploy-keys", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new deploy key in a project.\n\nExample:\n```\n$ curl -X POST \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT/deploy-keys/ -d \\\n'{\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/" }, { "info": { "name": "Atlassian Get a project deploy key", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/deploy-keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The key ID matching the project deploy key." }, { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the deploy key belonging to a specific key ID." }, { "info": { "name": "Atlassian Delete a deploy key from a project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/deploy-keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The key ID matching the project deploy key." }, { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual `key` assigned\nto the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This deletes a deploy key from a project." }, { "info": { "name": "Atlassian List explicit group permissions for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of explicit group permissions for the given project.\nThis endpoint does not support BBQL features." }, { "info": { "name": "Atlassian Get an explicit group permission for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups/:group_slug", "params": [ { "name": "group_slug", "value": "", "type": "path", "description": "Slug of the requested group." }, { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the group permission for a given group and project.\n\nOnly users with admin permission for the project may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `create-repo`\n* `write`\n* `read`\n* `none`" }, { "info": { "name": "Atlassian Update an explicit group permission for a project", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups/:group_slug", "params": [ { "name": "group_slug", "value": "", "type": "path", "description": "Slug of the requested group." }, { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the group permission, or grants a new permission if one does not already exist.\n\nOnly users with admin permission for the project may access this resource.\n\nDue to security concerns, the JWT and OAuth authentication methods are unsupported.\nThis is to ensure integrations and add-ons are not allowed to change permissions.\n\nPermissions can be:\n\n* `admin`\n* `create-repo`\n* `write`\n* `read`" }, { "info": { "name": "Atlassian Delete an explicit group permission for a project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups/:group_slug", "params": [ { "name": "group_slug", "value": "", "type": "path", "description": "Slug of the requested group." }, { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes the project group permission between the requested project and group, if one exists.\n\nOnly users with admin permission for the project may access this resource." }, { "info": { "name": "Atlassian List explicit user permissions for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of explicit user permissions for the given project.\nThis endpoint does not support BBQL features." }, { "info": { "name": "Atlassian Get an explicit user permission for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users/:selected_user_id", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "selected_user_id", "value": "", "type": "path", "description": "This can either be the username, the user's UUID surrounded by curly-braces,\nfor example: {account UUID}, or the user's Atlassian ID.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the explicit user permission for a given user and project.\n\nOnly users with admin permission for the project may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `create-repo`\n* `write`\n* `read`\n* `none`" }, { "info": { "name": "Atlassian Update an explicit user permission for a project", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users/:selected_user_id", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "selected_user_id", "value": "", "type": "path", "description": "This can either be the username, the user's UUID surrounded by curly-braces,\nfor example: {account UUID}, or the user's Atlassian ID.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the explicit user permission for a given user and project. The selected\nuser must be a member of the workspace, and cannot be the workspace owner.\n\nOnly users with admin permission for the project may access this resource.\n\nDue to security concerns, the JWT and OAuth authentication methods are unsupported.\nThis is to ensure integrations and add-ons are not allowed to change permissions.\n\nPermissions can be:\n\n* `admin`\n* `create-repo`\n* `write`\n* `read`" }, { "info": { "name": "Atlassian Delete an explicit user permission for a project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users/:selected_user_id", "params": [ { "name": "project_key", "value": "", "type": "path", "description": "The project in question. This is the actual key assigned to the project.\n" }, { "name": "selected_user_id", "value": "", "type": "path", "description": "This can either be the username, the user's UUID surrounded by curly-braces,\nfor example: {account UUID}, or the user's Atlassian ID.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes the project user permission between the requested project and user, if one exists.\n\nOnly users with admin permission for the project may access this resource.\n\nDue to security concerns, the JWT and OAuth authentication methods are unsupported.\nThis is to ensure integrations and add-ons are not allowed to change permissions." }, { "info": { "name": "Atlassian List Workspaces For User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/workspaces", "params": [ { "name": "role", "value": "", "type": "query", "description": "\n Filters the workspaces based on the authenticated user's role on each workspace.\n\n * **member**: returns a list of all the workspaces which the caller is a member of\n at least one workspace group or repository\n * **collaborator**: returns a list of workspaces which the caller has write access\n to at least one repository in the workspace\n * **owner**: returns a list of workspaces which the caller has administrator access\n " }, { "name": "q", "value": "", "type": "query", "description": "\nQuery string to narrow down the response. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details." }, { "name": "sort", "value": "", "type": "query", "description": "\nName of a response property to sort results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)\nfor details.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of workspaces accessible by the authenticated user.

Results may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering) by
workspace or permission by adding the following query string parameters:

* `q=slug=\"bbworkspace1\"` or `q=is_private=true`
* `sort=created_on`

Note that the query parameter values need to be URL escaped so that `=`
would become `%3D`.

**The `collaborator` role is being removed from the Bitbucket Cloud API. Fo" } ] } ], "bundled": true }