Class Security

Handles Basic Authentication for Bitbucket Data Center REST API requests.

Example

const security = new Security(
  'https://bitbucket.example.com',
  'my-user',
  'my-token'
);

const headers = security.getHeaders();
// { Authorization: 'Basic <base64>', 'Content-Type': 'application/json', Accept: 'application/json' }

Constructors

constructor

Methods

getApiUrl getAuthorizationHeader getHeaders

Constructors

constructor

  • new Security(apiUrl: string, user: string, token: string): Security

    Creates a new Security instance with Basic Authentication credentials.

    Parameters

    • apiUrl: string

      The base URL of the Bitbucket Data Center instance (e.g., https://bitbucket.example.com). Must be a valid URL; throws if it cannot be parsed.

    • user: string

      The username to authenticate with

    • token: string

      The personal access token or password to authenticate with

    Returns Security

    Throws

    If apiUrl is not a valid URL

Methods

getApiUrl

  • getApiUrl(): string

    Returns the base URL of the Bitbucket Data Center instance, without a trailing slash.

    Returns string

    The API base URL

getAuthorizationHeader

  • getAuthorizationHeader(): string

    Returns the value of the Authorization header for Basic Authentication.

    Returns string

    The Authorization header value in the format Basic <base64-encoded-credentials>

getHeaders

  • getHeaders(): Record<string, string>

    Returns the full set of HTTP headers required for authenticated API requests.

    Returns Record<string, string>

    An object containing Authorization, Content-Type, and Accept headers

Settings

Member Visibility

On This Page

Constructors
Methods