VuFind API Documentation

OauthServiceInterface

Interface for classes using OauthServiceTrait.

Classes which use this interface should also implement LoggerAwareInterface.

Tags
category

VuFind

author

Maccabee Levine msl321@lehigh.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link
https://vufind.org

Table of Contents

authenticateWithClientCredentials()  : string
Authenticate via the OAuth Client Credentials grant type.

Methods

authenticateWithClientCredentials()

Authenticate via the OAuth Client Credentials grant type.

public authenticateWithClientCredentials(string $oauthUrl, string $clientId, string $clientSecret) : string
Parameters
$oauthUrl : string

URL of thee OAuth service

$clientId : string

client_id for a client_credentials grant

$clientSecret : string

client_secret for a client_credentials grant

Tags
link
https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
Return values
string

token for the session or false if the token request failed

Search results