AuthenticationRequest
in package
Generates the Authentication Request
Table of Contents
- __construct() : AuthenticationRequest
- creates a new AuthenticationRequest instance
- getRedirectURL() : string
- creates the URL to OIDC Provider to which redirect the user
- send() : mixed
- redirect the browser with the authentication request to the URL to OIDC Provider
Methods
__construct()
creates a new AuthenticationRequest instance
public
__construct(array<string|int, mixed> $config[, array<string|int, mixed> $hooks = null ]) : AuthenticationRequest
Parameters
- $config : array<string|int, mixed>
-
base configuration
- $hooks : array<string|int, mixed> = null
-
hooks defined list
Tags
Return values
AuthenticationRequest —getRedirectURL()
creates the URL to OIDC Provider to which redirect the user
public
getRedirectURL(string $authorization_endpoint, array<string|int, int> $acr, array<string|int, string> $user_attributes, string $code_verifier, string $nonce, string $state) : string
Parameters
- $authorization_endpoint : string
-
autorization endpoint of the provider
- $acr : array<string|int, int>
-
array of int values of the acr params to send with the request
- $user_attributes : array<string|int, string>
-
array of string values of the user attributes to query with the request
- $code_verifier : string
-
value for PKCE code_verifier to send with the the request
- $nonce : string
-
value for nonce to send with the request
- $state : string
-
value for state to send with the request
Tags
Return values
string —URL of the authentication request
send()
redirect the browser with the authentication request to the URL to OIDC Provider
public
send(string $authorization_endpoint, array<string|int, int> $acr, array<string|int, string> $user_attributes, string $code_verifier, string $nonce, string $state) : mixed
Parameters
- $authorization_endpoint : string
-
autorization endpoint of the provider
- $acr : array<string|int, int>
-
array of int values of the acr params to send with the request
- $user_attributes : array<string|int, string>
-
array of string values of the user attributes to query with the request
- $code_verifier : string
-
value for PKCE code_verifier to send with the the request
- $nonce : string
-
value for nonce to send with the request
- $state : string
-
value for state to send with the request