| Recommend this page to a friend! |
| Info | Documentation | Reputation | Support forum | Blog | Links |
| Ratings | Unique User Downloads | Download Rankings | ||||
| Not yet rated by the users | Total: 207 | All time: 8,406 This week: 524 | ||||
| Version | License | PHP version | Categories | |||
| client-oauth2 1.0.0 | MIT/X Consortium ... | 5 | PHP 5, User Management, Web services |
| Description | Author | |
This package can authorize and access servers using OAuth2. |
Provides a simple and clean Abstraction for Integration with OAuth 2.0 Server Providers.
$auth = new \Poirot\OAuth2Client\Client(
'http://172.17.0.1:8000/'
, 'test@default.axGEceVCtGqZAdW3rc34sqbvTASSTZxD'
, 'xPWIpmzBK38MmDRd'
);
$url = $auth->attainAuthorizationUrl( $auth->withGrant('implicit') );
Retrieve Redirection To Authorize Url:
$url = $auth->attainAuthorizationUrl( $auth->withGrant(GrantPlugins::AUTHORIZATION_CODE) );
When User redirect back include Auth Code:
/ @var iAccessTokenObject $token */
$token = $auth->attainAccessToken(
$auth->withGrant(GrantPlugins::AUTHORIZATION_CODE, ['code' => 'your_auth_code'])
);
$token->getAccessToken();
$token->getScopes();
$token->getDateTimeExpiration();
// ...
override default scopes request
$token = $auth->attainAccessToken(
$auth->withGrant(GrantPlugins::CLIENT_CREDENTIALS, [ 'scopes' => ['override' ,'scopes'] ])
);
Specific Params Passed As Argument To Grant Factory
try {
$auth->attainAccessToken(
$auth->withGrant('password')
);
} catch (\Poirot\OAuth2Client\Exception\exMissingGrantRequestParams $e) {
// Request Param "username" & "password" must Set.
echo $e->getMessage();
$token = $token = $auth->attainAccessToken(
$auth->withGrant('password', ['username' => 'payam', 'password' => '123456'])
);
$refreshTokenStr = $token->getRefreshToken();
}
Specific Poirot Server Federation Commands To Deal 3rd party application with Server.
! For Federation Calls we need valid token: this token can strictly defined to client or retrieve from server.
example below show token asserted from oauth server when required!
// Setup OAuth2 Client
$client = new \Poirot\OAuth2Client\Client(
'http://172.17.0.1:8000/'
, 'test@default.axGEceVCtGqZAdW3rc34sqbvTASSTZxD'
, 'xPWIpmzBK38MmDRd'
);
// Token Provider for Federation Calls
// Use Credential Grant as Grant Type for Tokens
$tokenProvider = new TokenFromOAuthClient(
$client
, $client->withGrant('client_credentials')
);
// Note:
// Make Calls and Don`t Worry About Token Renewal And Expired Tokens.
// Platfrom Will Handle It.
$federation = new \Poirot\OAuth2Client\Federation(
'http://172.17.0.1:8000/'
, $tokenProvider
);
// Check wheather this identifier(s) is given by any user?
$checkExists = $federation->checkIdentifierGivenToAnyUser([
'email' => 'naderi.payam@gmail.com',
'mobile' => [
'number' => '9355497674',
'country' => '+98',
],
]);
| File | Role | Description | ||
|---|---|---|---|---|
| Data | Auxiliary data | |||
| Lic. | License text | |||
| Doc. | Documentation | |||
| / | mod |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| |
Example | Example script | ||
| / | mod | / | Actions |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| / | mod | / | Authenticate |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| / | mod | / | Authenticator |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| / | mod | / | config |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| / | mod | / | config | / | oauth2client |
| File | Role | Description |
|---|---|---|
| |
Aux. | Auxiliary script |
| |
Example | Example script |
| |
Class | Class source |
| / | mod | / | Services |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| / | mod | / | Services | / | Authenticate |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| / | mod | / | Services | / | Authenticators |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| / | src |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Example | Example script | ||
| / | src | / | Assertion |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| / | src | / | Assertion | / | RemoteServer |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| / | src | / | Client |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| / | src | / | Client | / | Command |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| / | src | / | Client | / | PlatformRest |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| / | src | / | Exception |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| / | src | / | Federation |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| / | src | / | Federation | / | Command |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| / | src | / | Federation | / | Command | / | Me |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| / | src | / | Federation | / | Command | / | Members |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| / | src | / | Federation | / | Command | / | Recover |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| / | src | / | Federation | / | TokenProvider |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| / | src | / | Grant |
| File | Role | Description | ||
|---|---|---|---|---|
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| |
Class | Class source | ||
| / | src | / | Interfaces |
| File | Role | Description |
|---|---|---|
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| |
Class | Class source |
| The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page. |
| Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
| 100% |
|
|
| Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.