Class UserResource

Readonlyslug

accessToken

• accessToken(tokenId: string): Promise<BitbucketAccessToken>

  Fetches a single HTTP access token by id.

  GET /rest/access-tokens/latest/users/{slug}/{tokenId}

  Parameters

  • tokenId: string

    The token id

  Returns Promise<BitbucketAccessToken>

  The access token metadata (without the raw token secret)

accessTokens

• accessTokens(
      params?: PaginationParams,
  ): Promise<PagedResponse<BitbucketAccessToken>>

  Fetches the HTTP access tokens associated with this user.

  GET /rest/access-tokens/latest/users/{slug}

  Parameters

  • Optionalparams: PaginationParams

    Optional pagination: limit, start

  Returns Promise<PagedResponse<BitbucketAccessToken>>

  A paged response of access tokens (without the raw token secrets)

addGpgKey

• addGpgKey(data: AddGpgKeyData): Promise<BitbucketGpgKey>

  Adds a GPG key to this user's account.

  POST /rest/gpg/latest/keys?user={slug}

  Adding a key to another user's account requires admin permission.

  Parameters

  • data: AddGpgKeyData

    The key to add: text (the ASCII-armored public key)

  Returns Promise<BitbucketGpgKey>

  The created GPG key

addSshKey

• addSshKey(data: AddSshKeyData): Promise<BitbucketSshKey>

  Adds an SSH key to this user's account.

  POST /rest/ssh/latest/keys?user={slug}

  Adding a key to another user's account requires admin permission.

  Parameters

  • data: AddSshKeyData

    The key to add: text, and optionally label and expiryDays

  Returns Promise<BitbucketSshKey>

  The created SSH key

  Example

  const key = await bbClient.user('pilmee').addSshKey({ text: 'ssh-ed25519 AAAA... laptop' });
  Copy

createAccessToken

• createAccessToken(
      data: CreateAccessTokenData,
  ): Promise<BitbucketCreatedAccessToken>

  Creates an HTTP access token for this user.

  PUT /rest/access-tokens/latest/users/{slug} — note that, unusually, this endpoint creates with PUT (and updates with POST).

  The response is the only place the raw token secret is ever returned — store it immediately, it cannot be retrieved again.

  Parameters

  • data: CreateAccessTokenData

    The token to create: name, permissions, and optionally expiryDays

  Returns Promise<BitbucketCreatedAccessToken>

  The created token, including the raw token secret

  Example

  const { token } = await bbClient.user('pilmee').createAccessToken({
    name: 'ci-read',
    permissions: ['REPO_READ'],
    expiryDays: 90,
  });
  Copy

deleteAccessToken

• deleteAccessToken(tokenId: string): Promise<void>

  Revokes an HTTP access token.

  DELETE /rest/access-tokens/latest/users/{slug}/{tokenId}

  Parameters

  • tokenId: string

    The token id

  Returns Promise<void>

deleteGpgKey

• deleteGpgKey(fingerprintOrId: string): Promise<void>

  Deletes a GPG key.

  DELETE /rest/gpg/latest/keys/{fingerprintOrId}

  Parameters

  • fingerprintOrId: string

    The key's fingerprint or id (see UserResource.gpgKeys)

  Returns Promise<void>

deleteSshKey

• deleteSshKey(keyId: number): Promise<void>

  Deletes an SSH key.

  DELETE /rest/ssh/latest/keys/{keyId}

  Parameters

  • keyId: number

    The id of the key to delete (see UserResource.sshKeys)

  Returns Promise<void>

get

• get(): Promise<BitbucketUser>

  Fetches the user details.

  GET /rest/api/latest/users/{slug}

  Returns Promise<BitbucketUser>

  The user object

gpgKeys

• gpgKeys(params?: PaginationParams): Promise<PagedResponse<BitbucketGpgKey>>

  Fetches the GPG keys associated with this user.

  GET /rest/gpg/latest/keys?user={slug}

  Parameters

  • Optionalparams: PaginationParams

    Optional pagination: limit, start

  Returns Promise<PagedResponse<BitbucketGpgKey>>

  A paged response of GPG keys

repo

• repo(repoSlug: string): RepositoryResource

  Returns a RepositoryResource for a given repository slug under this user, providing access to all repository sub-resources including raw, commits, branches, etc.

  Parameters

  • repoSlug: string

    The repository slug

  Returns RepositoryResource

  A chainable repository resource

  Example

  const repo    = await bbClient.user('pilmee').repo('my-repo');
  const content = await bbClient.user('pilmee').repo('my-repo').raw('src/index.ts');
  Copy

repos

• repos(params?: ReposParams): Promise<PagedResponse<BitbucketRepository>>

  Fetches repositories belonging to this user.

  Personal repositories live in the user's personal project (~{slug}), so this method queries the documented project repos endpoint.

  GET /rest/api/latest/projects/~{slug}/repos

  Parameters

  • Optionalparams: ReposParams

    Optional filters: limit, start, name, permission

  Returns Promise<PagedResponse<BitbucketRepository>>

  A paged response of repositories

settings

• settings(): Promise<BitbucketUserSettings>

  Fetches the settings of this user.

  GET /rest/api/latest/users/{slug}/settings

  Returns Promise<BitbucketUserSettings>

  The user settings object

sshKeys

• sshKeys(params?: PaginationParams): Promise<PagedResponse<BitbucketSshKey>>

  Fetches the SSH keys associated with this user.

  GET /rest/ssh/latest/keys?user={slug}

  Parameters

  • Optionalparams: PaginationParams

    Optional pagination: limit, start

  Returns Promise<PagedResponse<BitbucketSshKey>>

  A paged response of SSH keys

then

• then<TResult1 = BitbucketUser, TResult2 = never>(
      onfulfilled?:
          | ((value: BitbucketUser) => TResult1 | PromiseLike<TResult1>)
          | null,
      onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
  ): PromiseLike<TResult1 | TResult2>

  Allows the resource to be awaited directly, resolving with the user info. Delegates to UserResource.get.

  Type Parameters

  • TResult1 = BitbucketUser
  • TResult2 = never

  Parameters

  • Optionalonfulfilled: ((value: BitbucketUser) => TResult1 | PromiseLike<TResult1>) | null
  • Optionalonrejected: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null

  Returns PromiseLike<TResult1 | TResult2>

updateAccessToken

• updateAccessToken(
      tokenId: string,
      data: UpdateAccessTokenData,
  ): Promise<BitbucketAccessToken>

  Updates an HTTP access token's name, permissions, and/or expiry.

  POST /rest/access-tokens/latest/users/{slug}/{tokenId} — note that, unusually, this endpoint updates with POST (and creates with PUT).

  Parameters

  • tokenId: string

    The token id

  • data: UpdateAccessTokenData

    The fields to update

  Returns Promise<BitbucketAccessToken>

  The updated token metadata (without the raw token secret)

updateSettings

• updateSettings(settings: BitbucketUserSettings): Promise<void>

  Updates entries of this user's settings map. Only the keys present in settings are touched; other entries are left as they are.

  PUT /rest/api/latest/users/{slug}/settings

  Parameters

  • settings: BitbucketUserSettings

    The setting key/value pairs to update

  Returns Promise<void>