AuthorizationRequestHandlerSpiAdapter
extends UserClaimProviderAdapter
in package
implements
AuthorizationRequestHandlerSpi
An empty implementation of the AuthorizationRequestHandlerSpi interface.
Tags
Table of Contents
Interfaces
- AuthorizationRequestHandlerSpi
- The base interface for Service Provider Interfaces for authorization request handlers.
Methods
- getAcr() : string
- Get the authentication context class reference (ACR) that was satisfied when the end-user was authenticated.
- getProperties() : array<string|int, Property>
- Get arbitrary key-value pairs to be associated with an access token and/or an authorization code.
- getScopes() : array<string|int, string>
- Get the scopes to be associated with an access token and/or an authorization code.
- getSub() : string
- Get the value of the "sub" claim that will be embedded in an ID token.
- getUserAuthenticatedAt() : int
- Get the time when the end-user was authenticated.
- getUserClaimValue() : mixed
- Get the value of a claim of the user.
- getUserSubject() : string
- Get the subject (= unique identifier) of the end-user.
Methods
getAcr()
Get the authentication context class reference (ACR) that was satisfied when the end-user was authenticated.
public
getAcr() : string
Return values
string —The ACR that was satisfied when the end-user was authenticated. If
your system does not recognize ACR, null should be returned.
getProperties()
Get arbitrary key-value pairs to be associated with an access token and/or an authorization code.
public
getProperties() : array<string|int, Property>
Return values
array<string|int, Property> —Arbitrary key-value pairs to be associated with an access token.
getScopes()
Get the scopes to be associated with an access token and/or an authorization code.
public
getScopes() : array<string|int, string>
Return values
array<string|int, string> —Scopes which replace the scopes of the original authorization
request. If null is returned, the scopes will not be replaced.
getSub()
Get the value of the "sub" claim that will be embedded in an ID token.
public
getSub() : string
Return values
string —The value of the "sub" claim.
getUserAuthenticatedAt()
Get the time when the end-user was authenticated.
public
getUserAuthenticatedAt() : int
Return values
int —The time when the current end-user was authenticated. The number of seconds since the Unix epoch (1970-Jan-1). 0 means that the time is unknown.
getUserClaimValue()
Get the value of a claim of the user.
public
getUserClaimValue(string $subject, string $claimName, string $languageTag) : mixed
Parameters
- $subject : string
- $claimName : string
- $languageTag : string
Return values
mixed —The value of the claim. null if the value is not available.
The returned value must be able to be processed by json_encode().
getUserSubject()
Get the subject (= unique identifier) of the end-user.
public
getUserSubject() : string
Return values
string —The subject of the end-user.