protected property Client::$params in OAuth2 Client 7

Same name and namespace in other branches

1. 7.2 src/Client.php \OAuth2\Client::params

Associative array of the parameters that are needed by the different types of authorization flows.

• auth_flow :: server-side | client-credentials | user-password
• client_id :: Client ID, as registered on the oauth2 server
• client_secret :: Client secret, as registered on the oauth2 server
• token_endpoint :: something like: https://oauth2_server.example.org/oauth2/token
• authorization_endpoint :: somethig like: https://oauth2_server.example.org/oauth2/authorize
• redirect_uri :: something like: url('oauth2/authorized', array('absolute' => TRUE)) or https://oauth2_client.example.org/oauth2/authorized
• scope :: requested scopes, separated by a space
• username :: username of the resource owner
• password :: password of the resource owner
• skip-ssl-verification :: Skip verification of the SSL connection (needed for testing).

Type: array

File

./oauth2_client.inc, line 51

Class OAuth2\Client

Class

Client

The class OAuth2\Client is used to get authorization from an oauth2 server. Its only goal is to get an access_token from the oauth2 server, so the only public function (besides the constructor) is getAccessToken().

Namespace

OAuth2

Code

protected $params = array(
  'auth_flow' => NULL,
  'client_id' => NULL,
  'client_secret' => NULL,
  'token_endpoint' => NULL,
  'authorization_endpoint' => NULL,
  'redirect_uri' => NULL,
  'scope' => NULL,
  'username' => NULL,
  'password' => NULL,
  'skip-ssl-verification' => FALSE,
);