Skip to content

AuthenticationFailedException.md

Latest commit

 

History

History
93 lines (65 loc) · 1.91 KB

AuthenticationFailedException.md

File metadata and controls

93 lines (65 loc) · 1.91 KB
Raw

AuthenticationFailedException

Namespace: BhrSdk\Exceptions
Extends: ClientException
HTTP Status Code: 401

Description

Authentication failed

Usage

try {
    // API call that might fail with 401 status code
} catch (BhrSdk\Exceptions\AuthenticationFailedException $e) {
    // Handle the exception
    echo $e->getMessage();
    
    // Access additional information
    $causes = $e->getPotentialCauses();
    $tips = $e->getDebuggingTips();
    
    // Access response data
    $responseHeaders = $e->getResponseHeaders();
    $responseBody = $e->getResponseBody();
}

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

public function __construct(
    string $message,
    array $responseHeaders = [],
    $responseBody = null
)

Parameters

Name Type Description
$message string The error message
$responseHeaders array HTTP response headers from the API call
$responseBody mixed HTTP response body from the API call

Methods

getPotentialCauses()

Returns an array of potential causes for this exception.

public function getPotentialCauses(): array

getDebuggingTips()

Returns an array of debugging tips for this exception.

public function getDebuggingTips(): array

getResponseHeaders()

Returns the HTTP response headers from the API call that triggered this exception.

public function getResponseHeaders(): array

getResponseBody()

Returns the HTTP response body from the API call that triggered this exception.

public function getResponseBody()