AuthenticationFailedException.md

AuthenticationFailedException

Module: bamboohr_sdk.exceptions Extends: ClientException HTTP Status Code: 401

Description

Authentication failed

Usage

from bamboohr_sdk.exceptions import AuthenticationFailedException

try:
    # API call that might fail with 401 status code
    client.employees().get_employees_directory()
except AuthenticationFailedException as e:
    # Handle the exception
    print(e)

    # Access additional information
    causes = e.potential_causes()
    tips = e.debugging_tips()

    # Access response data
    print(f"Status: {e.status}")
    print(f"Request ID: {e.request_id}")
    if e.body:
        print(f"Response body: {e.body}")

Potential Causes

• Invalid API key or password
• Expired credentials
• Insufficient permissions for this operation

Debugging Tips

• Verify your API key and subdomain are correct
• Check that your API key has the necessary permissions
• Ensure your company subdomain is correct
• Try regenerating your API key in the BambooHR system

Constructor

AuthenticationFailedException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None,
    request_id: str | None = None,
)

Parameters

Name	Type	Description
status	int | None	HTTP status code
reason	str | None	HTTP reason phrase
http_resp	RESTResponse | None	The raw HTTP response object
body	str | None	HTTP response body
data	Any | None	Deserialized response data
request_id	str | None	Request ID from response headers

Methods

potential_causes()

Returns a list of potential causes for this exception.

@staticmethod
def potential_causes() -> list[str]

debugging_tips()

Returns a list of debugging tips for this exception.

@staticmethod
def debugging_tips() -> list[str]