{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Users API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Managed Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/v1/orgs/:orgId/users", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for paginated results." } ] }, "docs": "Returns a list of managed user accounts in the organization. Results are paginated using cursor-based pagination." }, { "info": { "name": "Atlassian Get Users in Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/v2/orgs/:orgId/directories/:directoryId/users", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "directoryId", "value": "", "type": "path", "description": "The unique identifier of the directory." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for paginated results." } ] }, "docs": "Returns a paginated list of users in a specific directory within the organization." }, { "info": { "name": "Atlassian Get User in Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/v2/orgs/:orgId/directories/:directoryId/users/:accountId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "directoryId", "value": "", "type": "path", "description": "The unique identifier of the directory." }, { "name": "accountId", "value": "", "type": "path", "description": "The Atlassian account identifier of the user." } ] }, "docs": "Returns details of a specific user in a directory within the organization." }, { "info": { "name": "Atlassian Remove User From Directory", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/v2/orgs/:orgId/directories/:directoryId/users/:accountId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "directoryId", "value": "", "type": "path", "description": "The unique identifier of the directory." }, { "name": "accountId", "value": "", "type": "path", "description": "The Atlassian account identifier of the user." } ] }, "docs": "Removes a user from a specific directory within the organization." }, { "info": { "name": "Atlassian Get Directory User Count", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/v2/orgs/:orgId/directories/:directoryId/users/count", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "directoryId", "value": "", "type": "path", "description": "The unique identifier of the directory." } ] }, "docs": "Returns the count of users in a specific directory." }, { "info": { "name": "Atlassian Invite Users to Organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/v2/orgs/:orgId/users/invite", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invites one or more users to the organization, optionally assigning them to directories, groups, and application roles." }, { "info": { "name": "Atlassian Suspend User Access", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/v2/orgs/:orgId/directories/:directoryId/users/:accountId/suspend", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "directoryId", "value": "", "type": "path", "description": "The unique identifier of the directory." }, { "name": "accountId", "value": "", "type": "path", "description": "The Atlassian account identifier of the user." } ] }, "docs": "Suspends a user's access within a specific directory of the organization." }, { "info": { "name": "Atlassian Restore User Access", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/v2/orgs/:orgId/directories/:directoryId/users/:accountId/restore", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "directoryId", "value": "", "type": "path", "description": "The unique identifier of the directory." }, { "name": "accountId", "value": "", "type": "path", "description": "The Atlassian account identifier of the user." } ] }, "docs": "Restores a previously suspended user's access within a specific directory of the organization." }, { "info": { "name": "Atlassian Grant User Product Access", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/v1/orgs/:orgId/users/:userId/roles/assign", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "userId", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Grants a user access to organization products by assigning roles." }, { "info": { "name": "Atlassian Revoke User Product Access", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/v1/orgs/:orgId/users/:userId/roles/revoke", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "userId", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Revokes a user's access to organization products by removing roles." }, { "info": { "name": "Atlassian List User Role Assignments", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/v2/orgs/:orgId/directories/:directoryId/users/:accountId/role-assignments", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "directoryId", "value": "", "type": "path", "description": "The unique identifier of the directory." }, { "name": "accountId", "value": "", "type": "path", "description": "The Atlassian account identifier of the user." } ] }, "docs": "Returns a list of role assignments for a specific user in a directory." }, { "info": { "name": "Atlassian Assign Organization-level Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/v1/orgs/:orgId/users/:userId/role-assignments/assign", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "userId", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns an organization-level role to a user." }, { "info": { "name": "Atlassian Remove Organization-level Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/v1/orgs/:orgId/users/:userId/role-assignments/revoke", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier of the organization." }, { "name": "userId", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes an organization-level role from a user." }, { "info": { "name": "Atlassian List Pull Requests for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/pullrequests/:selected_user", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "This can either be the username of the pull request author, the author's UUID\nsurrounded by curly-braces, for example: `{account UUID}`, or the author's Atlassian ID.\n" }, { "name": "state", "value": "", "type": "query", "description": "Only return pull requests that are in this state. This parameter can be repeated." } ], "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 pull requests authored by the specified user.

By default only open pull requests are returned. This can be controlled
using the `state` query parameter. To retrieve pull requests that are
in one of multiple states, repeat the `state` parameter for each
individual state.

This endpoint also supports filtering and sorting of the results. See
[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details." }, { "info": { "name": "Atlassian Add User to the Default Reviewers", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/default-reviewers/:target_username", "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": "target_username", "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": "This API operation adds a specific user to the default reviewers list for a Bitbucket repository within a given workspace. By making a PUT request to the endpoint with the workspace identifier, repository slug, and target username, administrators can configure automatic reviewer assignments for pull requests in that repository. When a user is added as a default reviewer, they will be automatically included in the reviewer list whenever a new pull request is created in the repository, streamlinin" }, { "info": { "name": "Atlassian Check if Current User Voted for an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/vote", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "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" } ], "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 checks whether the currently authenticated user has voted for a specific issue in a Bitbucket repository. By providing the workspace identifier, repository slug, and issue ID in the URL path, the API returns the voting status of the authenticated user for that particular issue. This operation is useful for applications that need to display voting state or manage user interactions with repository issues, allowing developers to determine if a user has already cast their vote befo" }, { "info": { "name": "Atlassian Check if Current User Is Watching Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/watch", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "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" } ], "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 check whether the currently authenticated user is watching a specific issue in a Bitbucket repository. By making a request to this endpoint with the workspace ID, repository slug, and issue ID, you'll receive a response indicating the watch status of the authenticated user for that particular issue. This is useful for applications that need to determine if a user has subscribed to receive notifications about updates, comments, or changes to a specific issue, enabl" }, { "info": { "name": "Atlassian List Explicit User Permissions for Repository", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/permissions-config/users", "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" } ], "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 explicit user permissions that have been directly assigned to a specific Bitbucket repository within a given workspace. By making a GET request to the endpoint with the workspace identifier and repository slug as path parameters, it returns detailed information about individual users who have been granted specific permission levels on the repository, excluding permissions inherited through group memberships or workspace-level settings. This is useful for re" }, { "info": { "name": "Atlassian Get an Explicit User Permission for Repository", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/permissions-config/users/:selected_user_id", "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": "selected_user_id", "value": "", "type": "path", "description": "This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account 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": "This API endpoint retrieves the explicit permission settings for a specific user on a particular Bitbucket repository within a workspace. By providing the workspace identifier, repository slug, and the selected user's ID in the path parameters, it returns detailed information about what level of access (such as read, write, or admin) has been directly granted to that user for the specified repository. This is useful for auditing user permissions, managing repository access control, and understan" }, { "info": { "name": "Atlassian Update an Explicit User Permission for Repository", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/permissions-config/users/:selected_user_id", "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": "selected_user_id", "value": "", "type": "path", "description": "This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account 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" } ], "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 the explicit permission level for a specific user on a Bitbucket repository within a workspace. This operation requires specifying the workspace identifier, repository slug, and the selected user's ID in the endpoint path. The PUT request allows repository administrators to modify access permissions for individual users, setting their level of access (such as read, write, or admin) directly on the repository. This is useful for managing fine-grained access control when you need to grant " }, { "info": { "name": "Atlassian Delete an Explicit User Permission for Repository", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/permissions-config/users/:selected_user_id", "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": "selected_user_id", "value": "", "type": "path", "description": "This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account 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": "This API operation removes an explicitly granted permission for a specific user from a Bitbucket repository by sending a DELETE request to the endpoint /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}. The operation requires three path parameters: the workspace identifier, the repository slug, and the selected user's ID whose permission is being revoked. When executed, it deletes the direct permission assignment for that user on the specified repository, meaning " }, { "info": { "name": "Atlassian Check if the Current User Is Watching Snippet", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/snippets/:workspace/:encoded_id/watch", "params": [ { "name": "encoded_id", "value": "", "type": "path", "description": "The snippet 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": "Used to check whether the authenticated user is watching a specific code snippet in a Bitbucket workspace. This endpoint accepts the workspace identifier and the encoded snippet ID as path parameters, returning the watch status for the current user. When called, it indicates if the user has subscribed to notifications for changes or updates to that particular snippet, helping users manage their snippet subscriptions and stay informed about modifications to code snippets they're interested in tra" }, { "info": { "name": "Atlassian List Users Watching Snippet", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/snippets/:workspace/:encoded_id/watchers", "params": [ { "name": "encoded_id", "value": "", "type": "path", "description": "The snippet 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 API endpoint retrieves a paginated list of all users who are currently watching a specific snippet in Bitbucket. By making a GET request to /snippets/{workspace}/{encoded_id}/watchers, you can access information about the watchers of a snippet identified by its encoded ID within a particular workspace. The endpoint returns user details for each watcher, allowing snippet owners and authorized users to see who is monitoring the snippet for updates or changes. This is useful for understanding " }, { "info": { "name": "Atlassian Create Variable for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/teams/:username/pipelines_config/variables", "params": [ { "name": "username", "value": "", "type": "path", "description": "The account." } ], "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 pipeline configuration variable for a specific Bitbucket team identified by the username parameter in the path. It allows administrators to define custom variables that can be used across pipeline configurations for the team, enabling centralized management of configuration values such as credentials, API keys, or environment-specific settings. The operation requires a POST request to the endpoint with the Teams username and the variable details in the request bo" }, { "info": { "name": "Atlassian Get Current User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/user", "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 Atlassian Bitbucket User API's GET /user endpoint retrieves detailed information about the currently authenticated user making the request. This operation returns a user object containing profile data such as the Users display name, username, account ID, avatar URL, and other associated account details. Authentication is required to access this endpoint, typically using OAuth 2.0, Basic Authentication with app passwords, or personal access tokens. The response provides comprehensive informat" }, { "info": { "name": "Atlassian List Email Addresses for Current User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/user/emails", "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 email addresses associated with the currently authenticated Bitbucket Users account. When invoked with a GET request to the /user/emails endpoint, it returns a collection of email addresses linked to the user, typically including details such as the email address itself, whether it's the primary email, and its verification status. This endpoint is useful for applications that need to access or display the Users registered email addresses, manage email preferences" }, { "info": { "name": "Atlassian Get an Email Address for Current User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/user/emails/:email", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email address of the user." } ], "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 information about a specific email address associated with the currently authenticated Bitbucket user. By making a GET request to the endpoint with a particular email address as a path parameter, users can verify whether that email belongs to their account and obtain related metadata such as confirmation status and whether it's set as the primary email. This is useful for applications that need to validate or manage email addresses linked to a Users Bitbucket account" }, { "info": { "name": "Atlassian List Repository Permissions for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/user/permissions/repositories", "params": [ { "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/#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 endpoint retrieves a paginated list of repositories for which the authenticated user has explicit permissions in Bitbucket. It returns repository objects along with the specific permission level (read, write, or admin) that the user has been granted for each repository. The response excludes repositories where the user has inherited permissions through team or group membership, focusing only on direct permission assignments. This operation requires authentication and uses a GET request " }, { "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 User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/users/:selected_user", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "This can either be an Atlassian Account ID OR the UUID of the account,\nsurrounded by curly-braces, for example: `{account 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 Atlassian Bitbucket User API endpoint /users/{selected_user} with the GET method retrieves detailed information about a specific user account within Bitbucket. By providing a username as the path parameter {selected_user}, this operation returns comprehensive user profile data including the Users display name, account ID, avatar URL, account status, and other publicly available information associated with that Users Bitbucket account. This endpoint is commonly used to fetch user details for " }, { "info": { "name": "Atlassian List Variables for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/users/:selected_user/pipelines_config/variables", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." } ], "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 pipeline configuration variables associated with a specific user in Atlassian Bitbucket. By sending a GET request to the endpoint with a selected user identifier, it returns the pipeline variables that have been configured at the user level, which can be used across multiple repositories and pipelines for that particular user. These variables typically include configuration settings, credentials, or other values needed for pipeline execution, allowing users" }, { "info": { "name": "Atlassian Create Variable for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/users/:selected_user/pipelines_config/variables", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." } ], "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 pipeline configuration variable for a specified Bitbucket user account. By sending a POST request to the endpoint with the target Users identifier, administrators can define custom variables that will be available across all pipelines associated with that Users repositories. The variables typically include key-value pairs used for storing configuration settings, credentials, or other data needed during pipeline execution, and can be marked as secured to protect s" }, { "info": { "name": "Atlassian Get Variable for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/users/:selected_user/pipelines_config/variables/:variable_uuid", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "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 a specific pipeline configuration variable for a given Bitbucket user by providing both the user identifier and the unique variable UUID. It allows administrators or authorized users to fetch details about an individual pipeline variable that has been configured at the user account level, which can include information such as the variable's key, value, secured status, and other metadata. This is useful when you need to inspect or verify the configuration of a specifi" }, { "info": { "name": "Atlassian Update Variable for User", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/users/:selected_user/pipelines_config/variables/:variable_uuid", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "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": "This API operation allows you to update an existing pipeline configuration variable for a specific Bitbucket user by providing the variable's unique identifier (UUID) and the target username. Using a PUT request to the endpoint, you can modify the variable's properties such as its value, security settings, or other configuration parameters that control how the variable behaves within Bitbucket Pipelines for that particular user. This is useful for maintaining and managing pipeline variables at t" }, { "info": { "name": "Atlassian Delete Variable for User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/users/:selected_user/pipelines_config/variables/:variable_uuid", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "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 removes a specific pipeline configuration variable associated with a Bitbucket user account by referencing the variable's unique identifier (UUID) and the target user. When executed, it permanently deletes the specified variable from the Users pipelines configuration, which means the variable will no longer be available for use in any pipeline executions related to that user. This DELETE operation requires both the selected_user parameter to identify the Bitbucket user account" }, { "info": { "name": "Atlassian Get User Application Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/users/:selected_user/properties/:app_key/:property_name", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "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 User Application Property operation retrieves a specific application property associated with a particular Bitbucket user. This endpoint requires three path parameters: the selected_user identifier, an app_key that identifies the application storing the property, and the property_name which specifies the exact property to retrieve. Application properties are key-value pairs that applications can store against user accounts for configuration, preferences, or other application-specific dat" }, { "info": { "name": "Atlassian Update User Application Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/users/:selected_user/properties/:app_key/:property_name", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "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 a specific application property for a selected user in Atlassian Bitbucket by sending a PUT request to the endpoint with the target username, application key, and property name as path parameters. The operation modifies an existing property value associated with a particular application for the specified user, enabling applications to store and manage user-specific configuration data or settings within Bitbucket's property storage system. This is useful fo" }, { "info": { "name": "Atlassian Delete User Application Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/users/:selected_user/properties/:app_key/:property_name", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "name": "app_key", "value": "", "type": "path", "description": "The key of the Connect app." }, { "name": "property_name", "value": "", "type": "path", "description": "The name of the property." } ], "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 application property associated with a Bitbucket user. By providing the selected Users identifier, the application key, and the property name in the request path, you can remove custom metadata or configuration data that was previously stored for that user within a particular application context. This is useful for cleaning up user-specific settings, removing outdated configuration values, or managing application data lifecycle when certain prop" }, { "info": { "name": "Atlassian Search for Code in Users Repositories", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/users/:selected_user/search/code", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." }, { "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": "The Atlassian Bitbucket User API endpoint `/users/{selected_user}/search/code` accessed via GET method enables developers to perform code searches across all repositories belonging to a specific user. By providing a username in the `{selected_user}` path parameter along with search query parameters, this operation scans through the code content within that user's repositories and returns matching results. This is particularly useful for finding specific code snippets, function names, variables, " }, { "info": { "name": "Atlassian List Explicit User Permissions for 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": "This API operation retrieves a list of explicit user permissions that have been granted for a specific project within a Bitbucket workspace. By providing the workspace identifier and project key as path parameters, the endpoint returns details about individual users who have been explicitly assigned permissions to the project, including their access levels and roles. This allows administrators to audit and review which users have direct access to a particular project, separate from any permissio" }, { "info": { "name": "Atlassian Get an Explicit User Permission for 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 Users UUID surrounded by curly-braces,\nfor example: {account UUID}, or the Users 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": "Retrieves the explicit permission details for a specific user within a designated project in a Bitbucket workspace. This endpoint requires three path parameters: the workspace slug identifying the Bitbucket workspace, the project key for the specific project, and the selected user ID representing the user whose permissions are being queried. When called, it returns the permission level that has been directly assigned to the specified user for that project, excluding any inherited permissions fro" }, { "info": { "name": "Atlassian Update an Explicit User Permission for 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 Users UUID surrounded by curly-braces,\nfor example: {account UUID}, or the Users 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 permission level for a specific user within a Bitbucket project workspace. This PUT operation requires the workspace slug, project key, and the selected user's ID as path parameters, allowing administrators to modify individual user access rights at the project level. The endpoint is used to grant, revoke, or change permission levels (such as read, write, or admin) for a particular user, overriding any inherited permissions from groups or workspace-level settings. This provi" }, { "info": { "name": "Atlassian Delete an Explicit User Permission for 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 Users UUID surrounded by curly-braces,\nfor example: {account UUID}, or the Users 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": "This API operation removes an explicitly assigned permission for a specific user within a Bitbucket project by making a DELETE request to the specified endpoint. It requires the workspace slug, project key, and the selected user's ID as path parameters to identify and revoke the user's direct access rights to the project. This operation is useful for project administrators who need to manage team access by removing individual user permissions, though it only affects explicit permissions and does" }, { "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 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": "This PUT operation adds a specified user as a default reviewer for a particular project within a Bitbucket workspace. By targeting the endpoint with the workspace slug, project key, and the selected user's identifier, it configures that user to be automatically added as a reviewer on all new pull requests created in the project. This helps streamline the code review process by ensuring designated team members are consistently included in pull request reviews without manual assignment, making it " }, { "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": "This API operation removes a specific user from the default reviewers list for a given project within a Bitbucket workspace. When invoked, it performs a DELETE request to the endpoint /workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}, where the workspace parameter identifies the workspace containing the project, project_key specifies the particular project, and selected_user indicates the user to be removed from the default reviewers. Once executed, the specified u" }, { "info": { "name": "Atlassian Get Content Restriction Status for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the restriction applies to." }, { "name": "operationKey", "value": "", "type": "path", "description": "The operation that is restricted." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Retrieves the restriction status for a specific user on a piece of Confluence content based on a given operation key. This endpoint allows you to check whether a particular user has access to perform a specific operation (such as read, update, or delete) on content identified by its ID. The operation key parameter specifies which type of operation restriction to check, while the request targets a specific user to determine if content restrictions apply to them. This is useful for administrators " }, { "info": { "name": "Atlassian Add User to Content Restriction", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the restriction applies to." }, { "name": "operationKey", "value": "", "type": "path", "description": "The operation that the restriction applies to." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Updates content restrictions by adding a user to a specific operation-based restriction on a Confluence content item. This endpoint allows administrators to grant a particular user permission to perform a specified operation (such as 'read' or 'update') on restricted content by adding them to the allowlist for that operation. The request requires the content ID, the operation key (the type of restriction being modified), and the user details to be added. This is useful for managing granular acce" }, { "info": { "name": "Atlassian Remove User From Content Restriction", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the restriction applies to." }, { "name": "operationKey", "value": "", "type": "path", "description": "The operation that the restriction applies to." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "This API operation removes a specific user from content restrictions for a given operation type in Atlassian Confluence. By making a DELETE request to the endpoint with the content ID, operation key (such as 'read' or 'update'), and user account ID as parameters, administrators can revoke previously granted or denied permissions for that user on the specified content. This is useful for managing access control when a user's permissions need to be changed or when cleaning up outdated restrictions" }, { "info": { "name": "Atlassian Get Anonymous User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/anonymous", "params": [ { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do." } ] }, "docs": "Returns information about how anonymous users are represented, like the
profile picture and display name.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get Current User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/current", "params": [ { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user." } ] }, "docs": "Returns the currently logged-in user. This includes information about
the user, like the display name, userKey, account ID, profile picture,
and more.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get Group Memberships for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/memberof", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned groups." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of groups to return per page.\nNote, this may be restricted by fixed system limits." } ] }, "docs": "Returns the groups that a user is a member of.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get Multiple Users Using Ids", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/bulk", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "A list of accountId's of users to be returned." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results returned.\nCurrently API returns 200 results max.\nIf more that 200 ids are passed first 200 will be returned." } ] }, "docs": "Returns user details for the ids provided in request.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get User Email Address", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/email", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. Required." } ] }, "docs": "Returns a user's email address. This API is only available to apps approved by
Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Get User Email Addresses in Batch", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user/email/bulk", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account IDs of the users." } ] }, "docs": "Returns user email addresses for a set of accountIds. This API is only available to apps approved by
Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).

Any accounts which are not available will not be included in the result.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission)." }, { "info": { "name": "Atlassian Bulk Get Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/bulk", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`." } ] }, "docs": "Returns a [paginated](#pagination) list of the users specified by one or more account IDs.

**[Permissions](#permissions) required:** Permission to access Jira." }, { "info": { "name": "Atlassian Get Account Ids For Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/bulk/migration", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "username", "value": "", "type": "query", "description": "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present." }, { "name": "key", "value": "", "type": "query", "description": "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present." } ] }, "docs": "Returns the account IDs for the users specified in the `key` or `username` parameters. Note that multiple `key` or `username` parameters can be specified.

**[Permissions](#permissions) required:** Permission to access Jira." }, { "info": { "name": "Atlassian Get User Default Columns", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/columns", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." } ] }, "docs": "Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If `accountId` is not passed in the request, the calling user's details are returned.

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column details for any user.
* Permission to access Jira, to get the calling user's column details." }, { "info": { "name": "Atlassian Set User Default Columns", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/user/columns", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.

The parameters for this resource are expressed as HTML form data. For example, in curl:

`curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'`

**[Permissions](#permissions) required:**

* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user.
* Permission to access Jira, to set the calling user's columns." }, { "info": { "name": "Atlassian Get User Email", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/email", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`." } ] }, "docs": "Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603)." }, { "info": { "name": "Atlassian Get User Email Bulk", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/email/bulk", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value)." } ] }, "docs": "Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603)." }, { "info": { "name": "Atlassian Get User Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user/groups", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." } ] }, "docs": "Returns the groups to which a user belongs.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Get All Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/users/search", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

**[Permissions](#permissions) required:** *Browse users and groups* [global per" }, { "info": { "name": "Atlassian Get User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/user", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user." } ] }, "docs": "Returns a user. This includes information about the user, such as the
display name, account ID, profile picture, and more. The information returned may be
restricted by the user's profile visibility settings.

**Note:** to add, edit, or delete users in your organization, see the
[user management REST API](/cloud/admin/user-management/about/).

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global " }, { "info": { "name": "Atlassian Get User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/user", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `groups` includes all groups and nested groups to which the user belongs.\n * `applicationRoles` includes details of all the applications to which the user has access." } ] }, "docs": "Returns a user.

Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Create User", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/user", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.

If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/user", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." } ] }, "docs": "Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account.

**[Permissions](#permissions) required:** Site administration (that is, membership of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL))." }, { "info": { "name": "Atlassian Get All Users Default", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/users", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

**[Permissions](#permissions) required:** *Browse users and groups* [global per" } ] } ], "bundled": true }