• 홈
• Auth0
• SDK
• API
• Oauth2Client

PHP 클래스 Auth0\SDK\API\Oauth2Client

파일 보기 프로젝트 열기: auth0/auth0-php

공개 프로퍼티들

프로퍼티	타입	설명
$URL_MAP	array	Auth0 URL Map.
$persistantMap	array	Available keys to persist data.

보호된 프로퍼티들

프로퍼티	타입	설명
$access_token	string	NULL means that there is no authorization yet.
$client_id	string	Auth0 Client ID
$client_secret	string	Auth0 Client Secret
$debug_mode	boolean	Debug mode flag.
$debugger	Closure	Will be called only if $debug_mode is true.
$domain	string	Auth0 Domain.
$oauth_client	OAuth2\Client	OAuth2 Client.
$redirect_uri	string	Redirect URI needed on OAuth2 requests.
$refresh_token	string	Auth0 Refresh Token
$user	string	The user object

공개 메소드들

메소드	설명
__construct ( array $config )	BaseAuth0 Constructor.
checkRequirements ( )	Checks for all dependencies of SDK or API.
debugInfo ( mixed $info )	If debug mode is set, sends $info to debugger \Closure.
deleteAllPersistentData ( )	Deletes all persistent data, for every mapped key.
exchangeCode ( ) : boolean	Exchanges the code from the URI parameters for an access token, id token and user info
getAccessToken ( ) : string	Gets $access_token.
getAppMetadata ( )
getClientId ( ) : string	Gets $client_id.
getClientSecret ( ) : string	Gets $client_secret.
getDebugMode ( ) : boolean	Gets $debug_mode.
getDebugger ( ) : Closure	Gets $debugger.
getDomain ( ) : string	Gets $domain
getIdToken ( ) : string	Gets the id token
getRedirectUri ( ) : string	Gets $redirect_uri.
getRefreshToken ( ) : string	Gets $refresh_token.
getUser ( ) : array	Requests user info to Auth0 server.
getUserMetadata ( )
logout ( )	Logout (removes all persisten data)
setAccessToken ( string $access_token ) : Auth0\SDK\BaseAuth0	Sets and persists $access_token.
setClientId ( string $client_id ) : Auth0\SDK\BaseAuth0	Sets $client_id.
setClientSecret ( string $client_secret ) : Auth0\SDK\BaseAuth0	Sets $client_secret.
setDebugMode ( boolean $debug_mode ) : Auth0\SDK\BaseAuth0	Sets $debug_mode.
setDebugger ( Closure $debugger ) : Auth0\SDK\BaseAuth0	Sets $debugger.
setDomain ( string $domain ) : Auth0\SDK\BaseAuth0	Sets $domain.
setIdToken ( string $id_token ) : Auth0\SDK\BaseAuth0	Sets and persists $id_token.
setRedirectUri ( string $redirect_uri ) : Auth0\SDK\BaseAuth0	Sets $redirect_uri.
setRefreshToken ( string $refresh_token ) : Auth0\SDK\BaseAuth0	Sets and persists $refresh_token.
setUser ( $user )
updateUserMetadata ( $metadata ) : User	Updathes the user metadata. This end up calling the path /users/{id_user} To delete an attribute, just set it null. ie: [ 'old_attr' => null ] It will only update the existing attrs and keep the others untouch for more info: https://auth0.com/docs/apiv2#!/users/patch_users_by_id

보호된 메소드들

메소드	설명
generateUrl ( string $domain_key, string $path = '/' ) : string	Constructs an API URL.

비공개 메소드들

메소드	설명
dontPersist ( String $name )	Removes $name from the persistantMap, thus not persisting it when we set the value

메소드 상세

프로퍼티 상세