Announcement — Introducing 'App User' type on Feb 9, 2023

Summary

To support the development of a new feature, we're introducing a new subtype of the Account definition called App User into the Bitbucket Cloud API. After a 6-month deprecation period, ending on Feb 9, 2023, any API which documents an Account type can start returning App User objects, along with the currently expected Team and User objects.

Why we’re adding the App User type

The App User type represents a new type of Bitbucket Account used by certain integrations and apps. The App User type shares the vast majority of its fields with the User type. However, it has some unique fields so we decided to create a new subtype of Account instead of overloading the User type.

We've included the App User definition in our swagger.json to allow vendors and users to integrate with the new data structure prior to the release date.

The app_user schema

1
2
"app_user": {
    "allOf": [
        {
            "$ref": "#/definitions/account"
        },
        {
            "type": "object",
            "title": "App User",
            "description": "An app user object.",
            "properties": {
                "account_id": {
                    "type": "string",
                    "description": "The user's Atlassian account ID."
                },
                "account_status": {
                    "type": "string",
                    "description": "The status of the account. Currently the only possible value is \"active\", but more values may be added in the future."
                },
                "kind": {
                    "type": "string",
                    "description": "The kind of App User."
                }
            },
            "additionalProperties": true
        }
    ]
}

What action is required?

Although there are many endpoints impacted by these changes, the actual changes should require little or no action from most developers. If you use our swagger.json file to auto-generate client code, you may wish to regenerate your client code.

Which schema objects are affected?

Account changes

• May return the new App User subtype.

Base Commit changes

• The author field may return the new App User subtype.

Branch Restriction changes

• The users array field may return the new App User subtype.
• The groups array field refers to type Group which has changes (See Group changes)

Branch changes

• The parent type Ref has changes (See Ref changes)

Branching Model changes

• The development field refers to type Ref which has changes (See Ref changes)
• The production field refers to type Ref which has changes (See Ref changes)

Comment changes

• The user field may return the new App User subtype.

Commit Comment changes

• The commit field refers to type Commit which has changes (See Commit changes)

Commit File changes

• The commit field refers to type Commit which has changes (See Commit changes)

Commit changes

• The author field may return the new App User subtype.
• The repository field refers to type Repository which has changes (See Repository changes)

Deploy Key changes

• The repository field refers to a type Repository which has changes (See Repository changes)
• The owner field may return the new App User subtype.

Deployment Release changes

• The commit field refers to a type Commit which has changes (See Commit changes)

Deployment State Completed changes

• The deployer field may return the new App User subtype.

Deployment State In Progress changes

• The deployer field may return the new App User subtype.

Deployment State changes

• No direct changes, but two subtypes have changes (See Deployment State In Progress changes and Deployment State Completed changes)

Deployment changes

• The release field refers to a type Deployment Release which has changes (See Deployment Release changes)
• The state field refers to a type Deployment State which has changes (See Deployment State changes)

Diff Stat changes

• The old field refers to type Commit File which has changes (See Commit File changes)
• The new field refers to type Commit File which has changes (See Commit File changes)

Group changes

• The owner field may return the new App User subtype.

Issue Change changes

• The user field may return the new App User subtype.
• The issue field refers to a type Issue which has changes (See Issue changes)

Issue Comment changes

• The issue field refers to type Issue which has changes (See Issue changes)
• The parent type Comment has changes (See Comment changes)

Issue changes

• The repository field refers to a type Repository which has changes (See Repository changes)
• The assignee field may return the new App User subtype.
• The reporter field may return the new App User subtype.

Paginated Accounts changes

• The values array field may return the new App User subtype.

Paginated Branches changes

• The values array field refers to type Branch which has changes (See Branch changes)

Paginated Changeset changes

• The values array field refers to type Base Commit which has changes (See Base Commit changes)

Paginated Commit Comments changes

• The values array field refers to type Commit Comment which has changes (See Commit Comment changes)

Paginated Deploy Keys changes

• The values array field refers to type Deploy Key which has changes (See Deploy Key changes)

Paginated Deployments changes

• The values array field refers to type Deployment which has changes (See Deployment changes)

Paginated Diff Stat changes

• The values array field refers to type Diff Stat which has changes (See Diff Stat changes)

Paginated Files changes

• The values array field refers to type Commit File which has changes (See Commit File changes)

Paginated Issue Comments changes

• The values array field refers to type Issue Comment which has changes (See Issue Comment changes)

Paginated Issues changes

• The values array field refers to type Issue which has changes (See Issue changes)

Paginated Log Entries changes

• The values array field refers to type Issue Change which has changes (See Issue Change changes)

Paginated Pipeline Schedule changes

• The values array field refers to type Pipeline Schedule which has changes (See Pipeline Schedule changes)

Paginated Pipelines changes

• The values array field refers to type Pipeline which has changes (See Pipeline changes)

Paginated Pull Request Comments changes

• The values array field refers to type Pull Request Comment which has changes (See Pull Request Comment changes)

Paginated Pull Requests changes

• The values array field refers to type Pull Request which has changes (See Pull Request changes)

Paginated Refs changes

• The values array field refers to type Ref which has changes (See Ref changes)

Paginated Repositories changes

• The values array field refers to type Repository which has changes (See Repository changes)

Paginated Repository Group Permissions changes

• The values array field refers to type Repository Group Permission which has changes (See Repository Group Permission changes)

Paginated Repository Permissions changes

• The values array field refers to type Repository Permission which has changes (See Repository Permission changes)

Paginated Repository User Permissions changes

• The values array field refers to type Repository User Permission which has changes (See Repository User Permission changes)

Paginated Snippet Comments changes

• The values array field refers to type Snippet Comment which has changes (See Snippet Comment changes)

Paginated Snippet Commits changes

• The values array field refers to type Snippet Commit which has changes (See Snippet Commit changes)

Paginated Snippets changes

• The values array field refers to type Snippet which has changes (See Snippet changes)

Paginated SSH User Keys changes

• The values array field refers to type SSH Account Key which has changes (See SSH Account Key changes)

Paginated Tags changes

• The values array field refers to type Tag which has changes (See Tag changes)

Paginated Tree Entry changes

• The values array field refers to type Tree Entry which has changes (See Tree Entry changes)

Paginated Workspace Memberships changes

• The values array field refers to type Workspace Membership which has changes (See Workspace Membership changes)

Participant changes

• The user field may return the new App User subtype.

Pipeline Commit Target changes

• The commit field refers to type Commit which has changes (See Commit changes)

Pipeline Ref Target changes

• The commit field refers to type Commit which has changes (See Commit changes)

Pipeline Schedule changes

• The target field refers to type Pipeline Target which has changes (See Pipeline Target changes)

Pipeline Target changes

• No direct changes, but two subtypes have changes (See Pipeline Ref Target changes and Pipeline Commit Target changes)

Pipeline changes

• The creator field may return the new App User subtype.
• The target field refers to type Commit which has changes (See Commit changes)

Pipelines Configuration changes

• The repository field refers to type Repository which has changes (See Repository changes)

Pull Request Comment changes

• The pullrequest field refers to type Pull Request which has changes (See Pull request changes)
• The parent type Comment has changes (See Comment changes)

Pull Request changes

• The author field may return the new App User subtype.
• The closed_by field may return the new App User subtype.
• The reviewers array field may return the new App User subtype.
• The participants array field refers to type Participant which has changes (See Participant changes)

Ref changes

• The target field refers to type Commit which has changes (See Commit changes)

Repository Group Permission changes

• The repository field refers to type Repository which has changes (See Repository changes)
• The group field refers to type Group which has changes (See Group changes)

Repository Permission changes

• The repository field refers to type Repository which has changes (See Repository changes)
• The user field may return the new App User subtype.

Repository User Permission changes

• The repository field refers to type Repository which has changes (See Repository changes)
• The user field may return the new App User subtype.

Repository changes

• The owner field may return the new App User subtype.

search_code_search_result changes

• The file field refers to type Commit File which has changes (See Commit File changes)

search_result_page changes

• The values array field refers to type search_code_search_result which has changes (See search_code_search_result changes)

Snippet Comment changes

• The snippet field refers to type Snippet which has changes (See Snippet changes)

Snippet Commit changes

• The snippet field refers to type Snippet which has changes (See Snippet changes)
• The parent type Base Commit has changes (See Base Commit changes)

Snippet changes

• The owner field may return the new App User subtype.
• The creator field may return the new App User subtype.

SSH Account Key changes

• The owner field may return the new App User subtype.

Tag changes

• The parent type Ref has changes (See Ref changes)

Tree Entry changes

• The commit field refers to type Commit which has changes (See Commit changes)

Workspace Membership changes

• The user field may return the new App User subtype.

Which API endpoints are affected?

Any API endpoints that return the Account type will be affected. From the release date, they will return one of the three Account subtypes: User, Team, or App User.

The following lists show all the endpoints which will be impacted after the deprecation period is over.

Addon endpoints

No changes

Branch restrictions endpoints

• GET /2.0/repositories/{workspace}/{repo_slug}/branch-restrictions - See Branch Restriction changes
• POST /2.0/repositories/{workspace}/{repo_slug}/branch-restrictions - See Branch Restriction changes
• GET /2.0/repositories/{workspace}/{repo_slug}/branch-restrictions/{id} - See Branch Restriction changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/branch-restrictions/{id} - See Branch Restriction changes

Branching model endpoints

• GET /2.0/repositories/{workspace}/{repo_slug}/branching-model - See Branching Model changes

Commit statuses endpoints

No changes

Commits endpoints

• GET /2.0/repositories/{workspace}/{repo_slug}/commit/{commit} - See Commit changes
• POST /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/approve - See Participant changes
• GET /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/comments - See Paginated Commit Comments changes
• POST /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/comments - See Commit Comment changes
• GET /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id} - See Commit Comment changes
• GET /2.0/repositories/{workspace}/{repo_slug}/commits - See Paginated Changeset changes
• POST /2.0/repositories/{workspace}/{repo_slug}/commits - See Paginated Changeset changes
• GET /2.0/repositories/{workspace}/{repo_slug}/commits/{revision} - See Paginated Changeset changes
• POST /2.0/repositories/{workspace}/{repo_slug}/commits/{revision} - See Paginated Changeset changes
• GET /2.0/repositories/{workspace}/{repo_slug}/diffstat/{spec} - See Paginated Diff Stat changes
• GET /2.0/repositories/{workspace}/{repo_slug}/merge-base/{revspec} - See Commit changes

Deployments endpoints

• GET /2.0/repositories/{workspace}/{repo_slug}/deploy-keys - See Paginated Deploy Keys changes
• POST /2.0/repositories/{workspace}/{repo_slug}/deploy-keys - See Deploy Key changes
• GET /2.0/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id} - See Deploy Key changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id} - See Deploy Key changes
• GET /2.0/repositories/{workspace}/{repo_slug}/deployments/ - See Paginated Deployments changes
• GET /2.0/repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid} - See Deployment changes

Downloads endpoints

No changes

Issue tracker endpoints

• GET /2.0/repositories/{workspace}/{repo_slug}/issues - See Paginated Issues changes
• POST /2.0/repositories/{workspace}/{repo_slug}/issues - See Issue changes
• GET /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id} - See Issue changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id} - See Issue changes
• DELETE /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id} - See Issue changes
• GET /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes - See Paginated Log Entries changes
• POST /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes - See Issue Change changes
• GET /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id} - See Issue Change changes
• GET /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments - See Paginated Issue Comments changes
• POST /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments - See Issue Comment changes
• GET /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} - See Issue Comment changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} - See Issue Comment changes
• DELETE /2.0/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} - See Issue Comment changes

Pipelines endpoints

• GET /2.0/repositories/{workspace}/{repo_slug}/pipelines/ - See Paginated Pipelines changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pipelines/ - See Pipeline changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid} - See Pipeline changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pipelines_config - See Pipelines Configuration changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/pipelines_config - See Pipelines Configuration changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/ - See Paginated Pipeline Schedule changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/ - See Pipeline Schedule changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} - See Pipeline Schedule changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} - See Pipeline Schedule changes

Projects endpoints

No changes

Pullrequests endpoints

• GET /2.0/pullrequests/{selected_user} - See Paginated Pull Requests changes
• GET /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests - See Paginated Pull Requests changes
• GET /2.0/repositories/{workspace}/{repo_slug}/default-reviewers - See Paginated Accounts changes
• GET /2.0/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username} - See Account changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username} - See Account changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pullrequests - See Paginated Pull Requests changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pullrequests - See Pull Request changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id} - See Pull Request changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id} - See Pull Request changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve - See Participant changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments - See Paginated Pull Request Comments changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments - See Pull Request Comment changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id} - See Pull Request Comment changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id} - See Pull Request Comment changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline - See Pull Request changes
• GET /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat - See Paginated Diff Stat changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge - See Pull Request changes
• POST /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes - See Participant changes

Refs changes

• GET /2.0/repositories/{workspace}/{repo_slug}/refs - See Paginated Refs changes
• GET /2.0/repositories/{workspace}/{repo_slug}/refs/branches - See Paginated Branches changes
• POST /2.0/repositories/{workspace}/{repo_slug}/refs/branches - See Branch changes
• GET /2.0/repositories/{workspace}/{repo_slug}/refs/branches/{name} - See Branch changes
• GET /2.0/repositories/{workspace}/{repo_slug}/refs/tags - See Paginated Tags changes
• POST /2.0/repositories/{workspace}/{repo_slug}/refs/tags - See Tag changes
• GET /2.0/repositories/{workspace}/{repo_slug}/refs/tags/{name} - See Tag changes

Reports changes

No changes

Repository changes

• GET /2.0/repositories - See Paginated Repositories changes
• GET /2.0/repositories/{workspace} - See Paginated Repositories changes
• GET /2.0/repositories/{workspace}/{repo_slug} - See Repository changes
• PUT /2.0/repositories/{workspace}/{repo_slug} - See Repository changes
• POST /2.0/repositories/{workspace}/{repo_slug} - See Repository changes
• GET /2.0/repositories/{workspace}/{repo_slug}/forks - See Paginated Repositories changes
• POST /2.0/repositories/{workspace}/{repo_slug}/forks - See Repository changes
• GET /2.0/repositories/{workspace}/{repo_slug}/permissions-config/groups - See Paginated Repository Group Permissions changes
• GET /2.0/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug} - See Repository Group Permission changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug} - See Repository Group Permission changes
• GET /2.0/repositories/{workspace}/{repo_slug}/permissions-config/users - See Paginated Repository User Permissions changes
• GET /2.0/repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id} - See Repository User Permission changes
• PUT /2.0/repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id} - See Repository User Permission changes
• GET /2.0/user/permissions/repositories - See Paginated Repository Permissions changes
• GET /2.0/repositories/{workspace}/{repo_slug}/watchers - See Paginated Accounts changes

Snippets changes

• GET /2.0/snippets - See Paginated Snippets changes
• POST /2.0/snippets - See Snippet changes
• GET /2.0/snippets/{workspace} - See Paginated Snippets changes
• POST /2.0/snippets/{workspace} - See Snippet changes
• GET /2.0/snippets/{workspace}/{encoded_id} - See Snippet changes
• PUT /2.0/snippets/{workspace}/{encoded_id} - See Snippet changes
• GET /2.0/snippets/{workspace}/{encoded_id}/comments - See Paginated Snippet Comments changes
• POST /2.0/snippets/{workspace}/{encoded_id}/comments - See Snippet Comment changes
• GET /2.0/snippets/{workspace}/{encoded_id}/comments/{comment_id} - See Snippet Comment changes
• PUT /2.0/snippets/{workspace}/{encoded_id}/comments/{comment_id} - See Snippet Comment changes
• GET /2.0/snippets/{workspace}/{encoded_id}/commits - See Paginated Snippet Commits changes
• GET /2.0/snippets/{workspace}/{encoded_id}/commits/{revision} - See Snippet Commit changes
• GET /2.0/snippets/{workspace}/{encoded_id}/watchers - See Paginated Accounts changes
• GET /2.0/snippets/{workspace}/{encoded_id}/{node_id} - See Snippet changes
• PUT /2.0/snippets/{workspace}/{encoded_id}/{node_id} - See Snippet changes

Source changes

• GET /2.0/repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path} - See Paginated Files changes
• GET /2.0/repositories/{workspace}/{repo_slug}/src - See Paginated Tree Entry changes
• GET /2.0/repositories/{workspace}/{repo_slug}/src/{commit}/{path} - See Paginated Tree Entry changes

Ssh changes

• GET /2.0/users/{selected_user}/ssh-keys - See Paginated SSH User Keys changes
• POST /2.0/users/{selected_user}/ssh-keys - See SSH Account Key changes
• GET /2.0/users/{selected_user}/ssh-keys/{key_id} - See SSH Account Key changes
• PUT /2.0/users/{selected_user}/ssh-keys/{key_id} - See SSH Account Key changes

Team changes

No changes

User changes

• GET /2.0/user - See Account changes
• GET /2.0/users/{selected_user} - See Account changes

Webhooks changes

No changes

Workspaces changes

• GET /2.0/user/permissions/workspaces - See Paginated Workspace Memberships changes
• GET /2.0/workspaces/{workspace}/members - See Paginated Workspace Memberships changes
• GET /2.0/workspaces/{workspace}/members/{member} - See Workspace Membership changes
• GET /2.0/workspaces/{workspace}/permissions - See Paginated Workspace Memberships changes
• GET /2.0/workspaces/{workspace}/permissions/repositories - See Paginated Repository Permissions changes
• GET /2.0/workspaces/{workspace}/permissions/repositories/{repo_slug} - See Paginated Repository Permissions changes

Other operations changes

• GET /2.0/users/{selected_user}/search/code - See search_result_page changes
• GET /2.0/workspaces/{workspace}/search/code - See search_result_page changes