API Authentication AuthenticationInterface - evansims/openfga-php GitHub Wiki
Interface for OpenFGA authentication strategies. This interface defines the contract for different authentication methods that can be used with the OpenFGA client. Authentication strategies handle the generation and management of authorization headers for API requests.
Table of Contents
OpenFGA\Authentication
public function getAuthenticationRequest(StreamFactoryInterface $streamFactory): RequestContext|nullGet an authentication request context if this strategy requires token acquisition. Returns a RequestContext for making an authentication request (such as OAuth token request) if the strategy needs to obtain tokens dynamically. Returns null for strategies that don't require authentication requests (like pre-shared tokens).
| Name | Type | Description |
|---|---|---|
$streamFactory |
StreamFactoryInterface |
Factory for creating request body streams |
RequestContext | null — The authentication request context, or null if not needed
public function getAuthorizationHeader(): string|nullGet the authorization header value for API requests. Returns the authorization header value to be included in HTTP requests to the OpenFGA API. The format and content depend on the specific authentication strategy implementation. For strategies that need to perform authentication requests (like OAuth), this method may trigger an authentication flow using getAuthenticationRequest().
string | null — The authorization header value, or null if no authentication is needed
public function handleAuthenticationResponse(ResponseInterface $response): voidHandle the authentication response and update internal state. This method is called by the Client after successfully sending an authentication request to update stored tokens or other authentication state. Implementations that don't require response handling can provide an empty implementation.
| Name | Type | Description |
|---|---|---|
$response |
ResponseInterface |
The authentication response |
void
public function requiresAuthentication(): boolCheck if authentication is required for this strategy.
bool — True if this strategy provides authentication, false for no-auth strategies