Package se.bjurr.bitbucketcloud.gen.api

Interface UserApi

@Path("/user") @Generated(value="org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", date="2025-07-17T16:07:08.420911588+02:00[Europe/Stockholm]", comments="Generator version: 7.14.0") public interface UserApi
Represents a collection of functions to interact with the API endpoints.

  • Method Details

    • userEmailsEmailGet

      @GET @Path("/emails/{email}") @Produces("application/json") Error userEmailsEmailGet(@PathParam("email") String email)
      Returns details about a specific one of the authenticated user's email addresses. Details describe whether the address has been confirmed by the user and whether it is the user's primary address or not.
      Parameters:
      email -
      Returns:
      Unexpected error.

    • userEmailsGet

      @GET @Path("/emails") @Produces("application/json") Error userEmailsGet()
      Returns all the authenticated user's email addresses. Both confirmed and unconfirmed.
      Returns:
      Unexpected error.

    • userGet

      @GET @Produces("application/json") User userGet()
      Returns the currently logged in user.
      Returns:
      The current user.

    • userPermissionsRepositoriesGet

      @GET @Path("/permissions/repositories") @Produces("application/json") PaginatedRepositoryPermissions userPermissionsRepositoriesGet(@QueryParam("q") String q, @QueryParam("sort") String sort)
      Returns an object for each repository the caller has explicit access to and their effective permission — the highest level of permission the caller has. This does not return public repositories that the user was not granted any specific permission in, and does not distinguish between direct and indirect privileges. Permissions can be: * `admin` * `write` * `read` Example: ``` $ curl https://api.bitbucket.org/2.0/user/permissions/repositories { \"pagelen\": 10, \"values\": [ { \"type\": \"repository_permission\", \"user\": { \"type\": \"user\", \"username\": \"evzijst\", \"nickname\": \"evzijst\", \"display_name\": \"Erik van Zijst\", \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\" }, \"repository\": { \"type\": \"repository\", \"name\": \"geordi\", \"full_name\": \"bitbucket/geordi\", \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\" }, \"permission\": \"admin\" } ], \"page\": 1, \"size\": 1 } ``` Results may be further [filtered or sorted](../../../meta/filtering) by repository or permission by adding the following query string parameters: * `q=repository.name=\"geordi\"` or `q=permission>\"read\"` * `sort=repository.name` Note that the query parameter values need to be URL escaped so that `=` would become `%3D`.
      Parameters:
      q - Query string to narrow down the response as per [filtering and sorting](../../../meta/filtering).
      sort - Name of a response property sort the result by as per [filtering and sorting](../../../meta/filtering#query-sort).
      Returns:
      Repository permissions for the repositories a caller has explicit access to.

    • userPermissionsTeamsGet

      @GET @Path("/permissions/teams") @Produces("application/json") PaginatedTeamPermissions userPermissionsTeamsGet(@QueryParam("q") String q, @QueryParam("sort") String sort)
      Returns an object for each team the caller is a member of, and their effective role — the highest level of privilege the caller has. If a user is a member of multiple groups with distinct roles, only the highest level is returned. Permissions can be: * `admin` * `collaborator` Example: ``` $ curl https://api.bitbucket.org/2.0/user/permissions/teams { \"pagelen\": 10, \"values\": [ { \"permission\": \"admin\", \"type\": \"team_permission\", \"user\": { \"type\": \"user\", \"username\": \"evzijst\", \"nickname\": \"evzijst\", \"display_name\": \"Erik van Zijst\", \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\" }, \"team\": { \"username\": \"bitbucket\", \"display_name\": \"Atlassian Bitbucket\", \"uuid\": \"{4cc6108a-a241-4db0-96a5-64347ac04f87}\" } } ], \"page\": 1, \"size\": 1 } ``` Results may be further [filtered or sorted](../../../meta/filtering) by team or permission by adding the following query string parameters: * `q=team.username=\"bitbucket\"` or `q=permission=\"admin\"` * `sort=team.display_name` Note that the query parameter values need to be URL escaped so that `=` would become `%3D`.
      Parameters:
      q - Query string to narrow down the response as per [filtering and sorting](../../../meta/filtering).
      sort - Name of a response property sort the result by as per [filtering and sorting](../../../meta/filtering#query-sort).
      Returns:
      Team permissions for the teams a caller is a member of.