Options
Options
class Options extends \Hazaar\Model\StructExtends: Hazaar\Model\Struct
Properties
issuer
public string $issuerType: string
authorization_path
public string $authorization_path = '/authorize'Type: string
token_path
public string $token_path = '/token'Type: string
registration_path
public string $registration_path = '/register'Type: string
revocation_path
public string $revocation_path = '/revoke'Type: string
registration_enabled
Whether dynamic client registration (RFC 7591, /register) is available at all. When
public bool $registration_enabled = trueType: bool
false, Hazaar\OAuth\Server::register answers 404 and the metadata omits registration_endpoint.
registration_access_token
public string $registration_access_tokenType: string
static_clients
Clients defined in configuration, with a fixed client_id. They are looked up ahead of the
public array $static_clientsType: array
clients repository and cannot be changed through it. See Hazaar\OAuth\Store\StaticClientRepository for the keys a definition takes.
scopes_supported
public array $scopes_supportedType: array
default_scope
public string $default_scopeType: string
token_endpoint_auth_methods_supported
public array $token_endpoint_auth_methods_supported = 'Protocol'Type: array
code_ttl
public int $code_ttl = 120Type: int
access_token_ttl
public int $access_token_ttl = 3600Type: int
refresh_token_ttl
public int $refresh_token_ttl = 1209600Type: int
refresh_token_reuse_grace
Seconds after a refresh token is exchanged during which presenting it again is still
public int $refresh_token_reuse_graceType: int
honoured rather than treated as theft, for clients that retry after losing the response. The default of 0 treats any reuse of a rotated token as a compromise and revokes the whole token family.
login_path
public string $login_path = '/login'Type: string
device_authorization_enabled
Enables the RFC 8628 device authorization grant: the device authorization endpoint, the
public bool $device_authorization_enabledType: bool
user verification action, and the device_code grant at /token. Off by default, so an existing deployment's metadata and behaviour are unchanged until it opts in.
device_authorization_path
public string $device_authorization_path = '/device_authorization'Type: string
device_verification_uri
Where users go to enter or confirm a user code: the application's own verification page,
public string $device_verification_uri = '/device'Type: string
which submits to Hazaar\OAuth\Server::deviceVerify. An absolute URL, or a path relative to issuer.
device_code_ttl
public int $device_code_ttl = 600Type: int
device_poll_interval
Minimum seconds between a device's polls of /token; faster polling gets slow_down.
public int $device_poll_interval = 5Type: int
device_verify_max_attempts
Failed user-code lookups allowed per user, and per client IP, within
public int $device_verify_max_attempts = 5Type: int
device_verify_window seconds (RFC 8628 §5.1). 0 disables the limit.
device_verify_window
public int $device_verify_window = 600Type: int
device_verify_backend
Hazaar\Util\RateLimiter backend that counts the failed attempts: cache, file
public string $device_verify_backend = 'cache'Type: string
or dbi.
clients
Hazaar\OAuth\Interface\ClientRepository implementation: a class-string, or an
public mixed $clients = 'ClientRepository'Type: mixed
already-constructed instance.
clients_options
Options passed through to clients when it is a class-string.
public array $clients_optionsType: array
codes
Hazaar\OAuth\Interface\AuthorizationCodeStore implementation: a class-string, or an
public mixed $codes = 'AuthorizationCodeStore'Type: mixed
already-constructed instance.
codes_options
Options passed through to codes when it is a class-string.
public array $codes_optionsType: array
refresh_tokens
Hazaar\OAuth\Interface\RefreshTokenStore implementation: a class-string, or an
public mixed $refresh_tokens = 'RefreshTokenStore'Type: mixed
already-constructed instance.
refresh_tokens_options
Options passed through to refresh_tokens when it is a class-string.
public array $refresh_tokens_optionsType: array
device_codes
Hazaar\OAuth\Interface\DeviceAuthorizationStore implementation: a class-string, or
public mixed $device_codes = 'DeviceAuthorizationStore'Type: mixed
an already-constructed instance. Only resolved when the device grant is used.
device_codes_options
Options passed through to device_codes when it is a class-string.
public array $device_codes_optionsType: array
jwt
Options passed through to the Hazaar\Auth\Session\Backend\JWT instance used to
public array $jwtType: array
mint and verify access tokens, exactly as auth.jwt would be. Not typed as Hazaar\Auth\Session\Backend\JWT\Options directly because this authorization server applies its own defaults (alg, issuer, expire, fingerprintKeys) that differ from that class's, only for keys the caller hasn't already supplied.
Generated by Hazaar API Doc Generator on Sun, 08 Nov 2026 03:36:15 +0000