Auth_OpenID_SetupNeededResponse
extends Auth_OpenID_ConsumerResponse
in package
A response with a status of Auth_OpenID_SETUP_NEEDED. Indicates that the request was in immediate mode, and the server is unable to authenticate the user without further interaction.
claimed_id - The identity URL for which authentication was attempted.
setup_url - A URL that can be used to send the user to the server to set up for authentication. The user should be redirected in to the setup_url, either in the current window or in a new browser window. Null in OpenID 2.
status - Auth_OpenID_SETUP_NEEDED.
Table of Contents
- $endpoint : Auth_OpenID_ServiceEndpoint
- $identity_url : null|string
- $setup_url : string
- $status : mixed
- __construct() : mixed
- Auth_OpenID_SetupNeededResponse constructor.
- getDisplayIdentifier() : mixed
- Return the display identifier for this response.
- setEndpoint() : mixed
Properties
$endpoint
public
Auth_OpenID_ServiceEndpoint
$endpoint
$identity_url
public
null|string
$identity_url
= \null
$setup_url
public
string
$setup_url
= ''
$status
public
mixed
$status
= \Auth_OpenID_SETUP_NEEDED
Methods
__construct()
Auth_OpenID_SetupNeededResponse constructor.
public
__construct(Auth_OpenID_ServiceEndpoint $endpoint[, string $setup_url = null ]) : mixed
Parameters
- $endpoint : Auth_OpenID_ServiceEndpoint
- $setup_url : string = null
Return values
mixed —getDisplayIdentifier()
Return the display identifier for this response.
public
getDisplayIdentifier() : mixed
The display identifier is related to the Claimed Identifier, but the two are not always identical. The display identifier is something the user should recognize as what they entered, whereas the response's claimed identifier (in the identity_url attribute) may have extra information for better persistence.
URLs will be stripped of their fragments for display. XRIs will display the human-readable identifier (i-name) instead of the persistent identifier (i-number).
Use the display identifier in your user interface. Use identity_url for querying your database or authorization server.
Return values
mixed —setEndpoint()
public
setEndpoint(Auth_OpenID_ServiceEndpoint|null $endpoint) : mixed
Parameters
- $endpoint : Auth_OpenID_ServiceEndpoint|null