ClientAuthConfig
in package
Configuration for PostgREST client authentication.
Contains various authentication settings, like credentials.
Table of Contents
Properties
- $authArguments : array<string|int, mixed>|null
- $authFunctionName : string
- $authSchemaName : string
- $autoAuth : bool
- $autoAuthGrace : int
Methods
- __construct() : mixed
- Create a new PostgREST client auth config.
Properties
$authArguments
public
array<string|int, mixed>|null
$authArguments
= null
$authFunctionName
public
string
$authFunctionName
= 'login'
$authSchemaName
public
string
$authSchemaName
= 'public'
$autoAuth
public
bool
$autoAuth
= false
$autoAuthGrace
public
int
$autoAuthGrace
= 300
Methods
__construct()
Create a new PostgREST client auth config.
public
__construct([string $authSchemaName = 'public' ][, string $authFunctionName = 'login' ][, null|array<string, mixed> $authArguments = null ][, bool $autoAuth = false ][, int $autoAuthGrace = 300 ]) : mixed
Parameters
- $authSchemaName : string = 'public'
-
The schema name to use for authentication.
- $authFunctionName : string = 'login'
-
The function name to use for authentication.
- $authArguments : null|array<string, mixed> = null
-
The arguments passed to the login function.
- $autoAuth : bool = false
-
Whether to ensure authentication before every request.
- $autoAuthGrace : int = 300
-
The grace period in seconds before the authentication token expires.