Docs For Class Veriplace_UserDiscoveryAPI

Description

Low-level interface for obtaining user identity information from Veriplace, when using the Veriplace_Client directly rather than the Veriplace API.

User identity can be obtained in one of two ways:

Using some known personally identifiable information, such as an email address
Using User Agent redirection to get the current user to identify themselves

Both requests use OAuth; in the former case, an application-specific Access Token is used to sign the protected resource request whereas in the latter case, a successful redirect results in Veriplace issuing a one-time Access Token.

Located in /Veriplace/Client.php (line 792)

Veriplace_API
   |
   --Veriplace_UserDiscoveryAPI

Method Summary

string getAuthorizationURI (string $callback, boolean $immediate)

Veriplace_User getUser (Veriplace_Token $accessToken)

Veriplace_User getUserByParameters (Veriplace_UserDiscoveryParameters $params)

array getUsersByParameters ( $paramsList)

Methods

getAuthorizationURI (line 804)

Get the URI to use for user redirection to acquire permission to identify the current user.

return: The OAuth redirection URI.
throws: Veriplace_TransportException if there is an I/O error
throws: Veriplace_OAuthException if the server refused the request
access: public

string getAuthorizationURI (string $callback, boolean $immediate)

string $callback: The OAuth callback URI.
boolean $immediate: Should responses return immediately if user interaction would be required?

getUser (line 818)

Find an enrolled user by supplying a one-time Access Token.

return: The user.
throws: Veriplace_UnexpectedException if there was an unexpected I/O error or OAuth error
throws: Veriplace_UserDiscoveryException if the server refused the request
access: public

Veriplace_User getUser (Veriplace_Token $accessToken)

Veriplace_Token $accessToken: The access token permitting the user to be discovered.

getUserByParameters (line 833)

Find an enrolled user by supplying a known identifying property.

This request uses the application-specific Access Token.

return: the user or null if none
throws: Veriplace_UnexpectedException if there was an unexpected I/O error or OAuth error
throws: Veriplace_UserDiscoveryException if the server refused the request
access: public

Veriplace_User getUserByParameters (Veriplace_UserDiscoveryParameters $params)

Veriplace_UserDiscoveryParameters $params: The identifying information.

getUsersByParameters (line 853)

Find multiple enrolled users by supplying a list of identifying properties.

This request uses the application-specific Access Token.

return: an associative array in which each key is the mobile number (or email, etc.) used to look up the user, and each value is a Veriplace_User
throws: Veriplace_UnexpectedException if there was an unexpected I/O error or OAuth error
throws: Veriplace_UserDiscoveryException if the server refused the request
access: public

array getUsersByParameters ( $paramsList)

array $paramsList: An array of Veriplace_UserDiscoveryParameters objects.