Skip to content

Latest commit

 

History

History
380 lines (222 loc) · 14.6 KB

UsersApi.md

File metadata and controls

380 lines (222 loc) · 14.6 KB
Raw

\UsersApi

All URIs are relative to https://api.bitbucket.org/2.0

Method HTTP request Description
TeamsUsernameRepositoriesGet Get /teams/{username}/repositories
UserEmailsEmailGet Get /user/emails/{email}
UserEmailsGet Get /user/emails
UserGet Get /user
UsersUsernameFollowersGet Get /users/{username}/followers
UsersUsernameFollowingGet Get /users/{username}/following
UsersUsernameGet Get /users/{username}
UsersUsernameHooksGet Get /users/{username}/hooks
UsersUsernameHooksPost Post /users/{username}/hooks
UsersUsernameHooksUidDelete Delete /users/{username}/hooks/{uid}
UsersUsernameHooksUidGet Get /users/{username}/hooks/{uid}
UsersUsernameHooksUidPut Put /users/{username}/hooks/{uid}
UsersUsernameRepositoriesGet Get /users/{username}/repositories

TeamsUsernameRepositoriesGet

ModelError TeamsUsernameRepositoriesGet(ctx, username)

All repositories owned by a user/team. This includes private repositories, but filtered down to the ones that the calling user has access to.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserEmailsEmailGet

ModelError UserEmailsEmailGet(ctx, 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
email string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserEmailsGet

ModelError UserEmailsGet(ctx, )

Returns all the authenticated user's email addresses. Both confirmed and unconfirmed.

Required Parameters

This endpoint does not need any parameter.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGet

User UserGet(ctx, )

Returns the currently logged in user.

Required Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameFollowersGet

PaginatedUsers UsersUsernameFollowersGet(ctx, username)

Returns the list of accounts that are following this user. This operation has been deprecated due to privacy changes. See the announcement for details.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account's username

Return type

PaginatedUsers

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameFollowingGet

PaginatedUsers UsersUsernameFollowingGet(ctx, username)

Returns the list of accounts this user is following. This operation has been deprecated due to privacy changes. See the announcement for details.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The user's username

Return type

PaginatedUsers

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameGet

User UsersUsernameGet(ctx, username)

Gets the public information associated with a user account. If the user's profile is private, location, website and created_on elements are omitted. Note that the user object returned by this operation is changing significantly, due to privacy changes. See the announcement for details.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account's UUID, account_id, or username. Note that username has been deprecated due to privacy changes.

Return type

User

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameHooksGet

PaginatedWebhookSubscriptions UsersUsernameHooksGet(ctx, username)

Returns a paginated list of webhooks installed on this user account. Note that the username path parameter has been deprecated due to privacy changes. Use the account's UUID or account_id instead.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string

Return type

PaginatedWebhookSubscriptions

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameHooksPost

WebhookSubscription UsersUsernameHooksPost(ctx, username)

Creates a new webhook on the specified user account. Account-level webhooks are fired for events from all repositories belonging to that account. Note that one can only register webhooks on one's own account, not that of others. Also, note that the username path parameter has been deprecated due to privacy changes. Use the account's UUID or account_id instead.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string

Return type

WebhookSubscription

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameHooksUidDelete

UsersUsernameHooksUidDelete(ctx, username, uid)

Deletes the specified webhook subscription from the given user account. Note that the username path parameter has been deprecated due to privacy changes. Use the account's UUID or account_id instead.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
uid string The installed webhook's id

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameHooksUidGet

WebhookSubscription UsersUsernameHooksUidGet(ctx, username, uid)

Returns the webhook with the specified id installed on the given user account. Note that the username path parameter has been deprecated due to privacy changes. Use the account's UUID or account_id instead.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
uid string The installed webhook's id.

Return type

WebhookSubscription

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameHooksUidPut

WebhookSubscription UsersUsernameHooksUidPut(ctx, username, uid)

Updates the specified webhook subscription. The following properties can be mutated: * description * url * active * events Note that the username path parameter has been deprecated due to privacy changes. Use the account's UUID or account_id instead.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
uid string The installed webhook's id

Return type

WebhookSubscription

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersUsernameRepositoriesGet

ModelError UsersUsernameRepositoriesGet(ctx, username)

All repositories owned by a user/team. This includes private repositories, but filtered down to the ones that the calling user has access to.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]