Atlassian Jira Announcement Banner API

openapi: 3.0.0
info:
  title: Atlassian Bit Bucket Workspaces API
  description: >-
    The Atlassian BitBucket Workspaces API is a powerful tool that allows users
    to manage and interact with multiple projects within their BitBucket
    account. With this API, users can create, update, and delete workspaces, as
    well as manage permissions and settings for each workspace. Additionally,
    the API enables users to create and manage repositories within their
    workspaces, facilitating collaboration and efficient project management. 
  version: '2.0'
  termsOfService: https://www.atlassian.com/legal/customer-agreement
  contact:
    name: Bitbucket Support
    url: https://support.atlassian.com/bitbucket-cloud/
    email: [email protected]
paths:
  /workspaces/{workspace}:
    get:
      tags:
        - Get
        - Workspaces
      description: >-
        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 to the workspace itself.
      summary: Atlassian Get A Workspace
      responses:
        '200':
          description: The workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspace'
              examples:
                workspace:
                  $ref: '#/components/examples/workspace'
        '404':
          description: If no workspace exists for the specified name or UUID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2: []
        - basic: []
        - api_key: []
      operationId: atlassianGetAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/hooks:
    get:
      tags:
        - Lists
        - Webhooks
        - Workspaces
      description: >-
        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
        callbacks to external services when specific events occur within the
        workspace, such as repository pushes, pull request updates, or other
        Bitbucket activities.
      summary: Atlassian List Webhooks For A Workspace
      responses:
        '200':
          description: The paginated list of installed webhooks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_webhook_subscriptions'
              examples:
                paginated-webhook-subscriptions:
                  $ref: '#/components/examples/paginated-webhook-subscriptions'
        '403':
          description: >-
            If the authenticated user is not an owner on the specified
            workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: If the specified workspace does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2:
            - webhook
        - basic: []
        - api_key: []
      operationId: atlassianListWebhooksForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    post:
      tags:
        - Create
        - Webhooks
        - Workspaces
      description: >-
        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
        containing webhook configuration details including the target URL where
        events should be sent, a description, and the specific events to
        subscribe to. Upon successful creation, the API returns the newly
        created webhook object with its unique identifier and configuration
        details, enabling automated integrations and event-driven workflows
        between Bitbucket and external systems or services.
      summary: Atlassian Create A Webhook For A Workspace
      responses:
        '201':
          description: If the webhook was registered successfully.
          headers:
            Location:
              description: The URL of new newly created webhook.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_subscription'
              examples:
                webhook-subscription:
                  $ref: '#/components/examples/webhook-subscription'
        '403':
          description: >-
            If the authenticated user does not have permission to install
            webhooks on the specified workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: If the specified workspace does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2:
            - webhook
        - basic: []
        - api_key: []
      operationId: atlassianCreateAWebhookForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/hooks/{uid}:
    delete:
      tags:
        - Delete
        - Webhooks
        - Workspaces
      description: >-
        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 is typically used when a webhook is no longer needed,
        when cleaning up old integrations, or when reconfiguring webhook
        settings by removing the old webhook before creating a new one.
        Authentication and appropriate workspace permissions are required to
        perform this delete operation.
      summary: Atlassian Delete A Webhook For A Workspace
      responses:
        '204':
          description: When the webhook was deleted successfully
        '403':
          description: >-
            If the authenticated user does not have permission to delete the
            webhook.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: If the webhook or workspace does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2:
            - webhook
        - basic: []
        - api_key: []
      operationId: atlassianDeleteAWebhookForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
    get:
      tags:
        - Get
        - Webhooks
      description: >-
        This API operation retrieves detailed information about a specific
        webhook configured for an Atlassian Bitbucket workspace. By providing
        the workspace identifier and the unique webhook ID (uid) in the endpoint
        path, you can fetch the webhook's configuration details including its
        URL, events it subscribes to, active status, and other metadata. This is
        useful for verifying webhook settings, auditing workspace integrations,
        or programmatically managing webhook configurations within your
        Bitbucket workspace.
      summary: Atlassian Get A Webhook For A Workspace
      responses:
        '200':
          description: The webhook subscription object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_subscription'
              examples:
                webhook-subscription_2:
                  $ref: '#/components/examples/webhook-subscription_2'
        '404':
          description: If the webhook or workspace does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2:
            - webhook
        - basic: []
        - api_key: []
      operationId: atlassianGetAWebhookForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    put:
      tags:
        - Update
        - Webhooks
        - Workspaces
      description: >-
        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 authentication with appropriate permissions to manage workspace
        webhooks, and upon successful execution, it returns the updated webhook
        object with all its current configuration details including the modified
        properties.
      summary: Atlassian Update A Webhook For A Workspace
      responses:
        '200':
          description: The webhook subscription object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_subscription'
              examples:
                webhook-subscription_2:
                  $ref: '#/components/examples/webhook-subscription_2'
        '403':
          description: >-
            If the authenticated user does not have permission to update the
            webhook.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: If the webhook or workspace does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2:
            - webhook
        - basic: []
        - api_key: []
      operationId: atlassianUpdateAWebhookForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: uid
        in: path
        description: Installed webhook's ID
        required: true
        schema:
          type: string
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/members:
    get:
      tags:
        - Lists
        - Users
        - Workspaces
      description: >-
        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 useful for auditing purposes, managing team access, or
        integrating workspace member data with external systems for user
        management and collaboration workflows.
      summary: Atlassian List Users In A Workspace
      responses:
        '200':
          description: The list of users that are part of a workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_workspace_memberships'
              examples:
                paginated-workspace-memberships:
                  $ref: '#/components/examples/paginated-workspace-memberships'
        '401':
          description: The request wasn't authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2:
            - account
        - basic: []
        - api_key: []
      x-atlassian-oauth2-scopes:
        - state: Current
          scheme: oauth2
          scopes:
            - read:workspace:bitbucket
            - read:user:bitbucket
      operationId: atlassianListUsersInAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/members/{member}:
    get:
      tags:
        - Get
        - Memberships
        - Users
        - Workspaces
      description: >-
        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, check membership status, or retrieve specific
        member details for workspace management purposes.
      summary: Atlassian Get User Membership For A Workspace
      responses:
        '200':
          description: The user that is part of a workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspace_membership'
              examples:
                workspace-membership:
                  $ref: '#/components/examples/workspace-membership'
        '401':
          description: The request wasn't authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: >-
            A workspace cannot be found, or a user cannot be found, or the user
            is not a a member of the workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2:
            - account
        - basic: []
        - api_key: []
      x-atlassian-oauth2-scopes:
        - state: Current
          scheme: oauth2
          scopes:
            - read:workspace:bitbucket
            - read:user:bitbucket
      operationId: atlassianGetUserMembershipForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: member
        in: path
        description: Member's UUID or Atlassian ID.
        required: true
        schema:
          type: string
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/permissions:
    get:
      tags:
        - Lists
        - Permissions
        - Users
        - Workspaces
      description: >-
        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 to audit user access, manage team permissions, or integrate
        workspace permission data into external systems for security and
        compliance purposes. The response typically includes user details like
        usernames, display names, and their associated permission grants within
        the specified workspace context.
      summary: Atlassian List User Permissions In A Workspace
      responses:
        '200':
          description: >-
            The list of users that are part of a workspace, along with their
            permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_workspace_memberships'
              examples:
                paginated-workspace-memberships_2:
                  $ref: '#/components/examples/paginated-workspace-memberships_2'
        '401':
          description: The request wasn't authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
        - name: q
          in: query
          description: |2-

            Query string to narrow down the response as per
            [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).
          required: false
          schema:
            type: string
      security:
        - oauth2:
            - account
        - basic: []
        - api_key: []
      x-atlassian-oauth2-scopes:
        - state: Current
          scheme: oauth2
          scopes:
            - read:workspace:bitbucket
            - read:user:bitbucket
      operationId: atlassianListUserPermissionsInAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/permissions/repositories:
    get:
      tags:
        - All
        - Lists
        - Permissions
        - Repositories
        - Workspaces
      description: >-
        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 the response typically includes information about
        users, groups, and their associated permission levels across all
        repositories within that workspace scope.
      summary: Atlassian List All Repository Permissions For A Workspace
      responses:
        '200':
          description: List of workspace's repository permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_repository_permissions'
              examples:
                paginated-repository-permissions:
                  $ref: '#/components/examples/paginated-repository-permissions'
        '403':
          description: The requesting user isn't an admin of the workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
        - name: q
          in: query
          description: |2-

            Query string to narrow down the response as per
            [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).
          required: false
          schema:
            type: string
        - name: sort
          in: query
          description: >2

            Name of a response property sort the result by as per

            [filtering and
            sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).
          required: false
          schema:
            type: string
      security:
        - oauth2:
            - account
        - basic: []
        - api_key: []
      x-atlassian-oauth2-scopes:
        - state: Current
          scheme: oauth2
          scopes:
            - read:repository:bitbucket
            - read:user:bitbucket
      operationId: atlassianListAllRepositoryPermissionsForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/permissions/repositories/{repo_slug}:
    get:
      tags:
        - Lists
        - Permissions
        - Repositories
        - Workspaces
      description: >-
        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 repository access, verify security settings, or understand who
        has what level of access to a given repository within their Bitbucket
        workspace.
      summary: Atlassian List A Repository Permissions For A Workspace
      responses:
        '200':
          description: The repository permission for all users in this repository.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_repository_permissions'
              examples:
                paginated-repository-permissions_2:
                  $ref: '#/components/examples/paginated-repository-permissions_2'
        '403':
          description: The requesting user isn't an admin of the repository.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
        - name: q
          in: query
          description: |2-

            Query string to narrow down the response as per
            [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).
          required: false
          schema:
            type: string
        - name: sort
          in: query
          description: >2

            Name of a response property sort the result by as per

            [filtering and
            sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).
          required: false
          schema:
            type: string
      security:
        - oauth2:
            - repository
        - basic: []
        - api_key: []
      x-atlassian-oauth2-scopes:
        - state: Current
          scheme: oauth2
          scopes:
            - read:repository:bitbucket
            - read:user:bitbucket
      operationId: atlassianListARepositoryPermissionsForAWorkspace
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
        GenerateExampleFromOperationResponseSchema: true
    parameters:
      - name: repo_slug
        in: path
        description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        required: true
        schema:
          type: string
      - name: workspace
        in: path
        description: |
          This can either be the workspace ID (slug) or the workspace UUID
          surrounded by curly-braces, for example: `{workspace UUID}`.
        required: true
        schema:
          type: string
  /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration:
    get:
      tags:
        - Configuration
        - Get
        - Openid Connect
        - Pipelines
      summary: Atlassian Get Openid Configuration For Oidc In Pipelines
      description: >-
        This API endpoint retrieves the OpenID Connect (OIDC) configuration for
        Bitbucket Pipelines within a specified workspace. It returns the
        well-known OpenID configuration document that contains metadata about
        the OIDC identity provider used by Pipelines, including supported
        endpoints, token signing algorithms, claims, and other OAuth 2.0 and
        OIDC protocol details. This configuration is essential for external
        services and cloud providers that need to establish trust and validate
        identity tokens issued by Bitbucket Pipelines when using OIDC
        authentication for secure, keyless deployments without storing
        long-lived credentials.
      operationId: atlassianGetoidcconfiguration
      parameters:
        - name: workspace
          description: >-
            This can either be the workspace ID (slug) or the workspace UUID
            surrounded by curly-braces, for example `{workspace UUID}`.
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The OpenID configuration
        '404':
          description: The workspace was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2: []
        - basic: []
        - api_key: []
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
  /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json:
    get:
      tags:
        - Get
        - Keys
        - Openid Connect
        - Pipelines
      summary: Atlassian Get Keys For Oidc In Pipelines
      description: >-
        This API endpoint retrieves the JSON Web Key Set (JWKS) containing the
        public keys used for OpenID Connect (OIDC) authentication in Bitbucket
        Pipelines for a specific workspace. It accepts a GET request to the path
        /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json, where
        {workspace} is replaced with the workspace ID or slug. The endpoint
        returns a keys.json file that contains cryptographic keys used to verify
        JWT tokens issued by Bitbucket Pipelines' OIDC provider, enabling secure
        identity federation between Pipelines and external services that support
        OIDC authentication.
      operationId: atlassianGetoidckeys
      parameters:
        - name: workspace
          description: >-
            This can either be the workspace ID (slug) or the workspace UUID
            surrounded by curly-braces, for example `{workspace UUID}`.
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The keys in JSON web key format
        '404':
          description: The workspace was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
        - oauth2: []
        - basic: []
        - api_key: []
      x-api-evangelist-processing:
        WriteDescription: true
        ChooseTags: true
  /workspaces/{workspace}/pipelines-config/variables:
    get:
      tags:
        - Lists
        - Variables
        - Workspaces
      summary: Atlassian List Variables For A Workspace
      description: >-
        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 that apply across multiple repositories within a workspace,
        enabling administrators to review what variables are defined and
        available for pipeline executions without needing to check individual
        repository settings.
      operationId: atlassianGetpipelinevariablesforworkspace
      parameters:
        - name: workspace
          description: >-
            This can either be the workspace ID (slug) or the workspace UUID
            surrounded by curly-braces, for example `{workspace UUID}`.
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The found workspace level variables.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_pipeline_variables'
              examples:
                paginated-pipeline-variables:
                  $ref: '#/components/examples/paginated-pipeline-variables'
      x-atlassian-oauth2-scopes:
        - state: Current
          scheme: oauth2
          scopes:
   

# --- truncated at 32 KB (303 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-rest-api-3-announcementbanner--openapi-original.yml