Update README.md

This commit is contained in:
Kasper Rynning-Tønnesen
2016-07-01 11:36:30 +02:00
committed by GitHub
parent d2a30e335c
commit a1e0a7abee

View File

@@ -17,33 +17,30 @@ To use this general OAuth2 client-class, include it with
]); ]);
``` ```
```(string) $client_id``` is client id of the OAuth2 application ```(string) $client_id``` is client id of the OAuth2 application
```(string) $client_secret``` is client secret of the OAuth2 application ```(string) $client_secret``` is client secret of the OAuth2 application
```(string) $redirect_uri``` is the specified redirect-uri for the OAuth2 application ```(string) $redirect_uri``` is the specified redirect-uri for the OAuth2 application
```(string) $auth``` is the full url for authorization ```(string) $auth``` is the full url for authorization
```(string) $token``` is the full token url ```(string) $token``` is the full token url
Optional - Optional -
```(string) $authorization_type``` defaults to Bearer ```(string) $authorization_type``` defaults to Bearer
```(boolean) $session``` specifies whether the state is to be saved in _SESSION storage, defaults to false ```(boolean) $session``` specifies whether the state is to be saved in _SESSION storage, defaults to false
```(boolean) $verify``` is whether to verify SSL of host and peer, defaults to true ```(boolean) $verify``` is whether to verify SSL of host and peer, defaults to true
```(string) $grant_type``` defaults to 'authorization_code' ```(string) $grant_type``` defaults to 'authorization_code'
```(string) $response_type``` defaults to 'code' ```(string) $response_type``` defaults to "code"
To start the redirect phase To start the redirect phase
```$oauth2->redirect($state);``` ```$oauth2->redirect($state);``` ($state defaults to false)
($state defaults to false)
To get access token To get access token
```$oauth2->get_access_token();``` ```$oauth2->get_access_token();``` returns the access_token.
returns the access_token.
(Optional value is $state, to check up against _SESSION variables) (Optional value is $state, to check up against _SESSION variables)