Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

options is optional in WebAuth.prototype.authorize #789

Merged
merged 3 commits into from
Jul 10, 2018
Merged

options is optional in WebAuth.prototype.authorize #789

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34e6fc0
options is optional in WebAuth.prototype.authorize
behrangsa Jul 6, 2018
3505992
Marked more optional `options` params as optional in JsDocs.
behrangsa Jul 10, 2018
2c84c86
Merge branch 'master' into master
luisrudge Jul 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/web-auth/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ WebAuth.prototype.validateToken = function(token, nonce, cb) {
* Watch out! If you're not using the hosted login page to do social logins, you have to use your own [social connection keys](https://manage.auth0.com/#/connections/social). If you use Auth0's dev keys, you'll always get `login_required` as an error when calling this method.
*
* @method renewAuth
* @param {Object} options
* @param {Object} [options]
* @param {String} [options.clientID] the Client ID found on your Application settings page
* @param {String} [options.redirectUri] url that the Auth0 will redirect after Auth with the Authorization Response
* @param {String} [options.responseType] type of the response used by OAuth 2.0 flow. It can be any space separated list of the values `code`, `token`, `id_token`. {@link https://openid.net/specs/oauth-v2-multiple-response-types-1_0}
Expand Down Expand Up @@ -435,7 +435,7 @@ WebAuth.prototype.renewAuth = function(options, cb) {
* Renews an existing session on Auth0's servers using `response_mode=web_message`
*
* @method checkSession
* @param {Object} options
* @param {Object} [options]

* @param {String} [options.clientID] the Client ID found on your Application settings page
* @param {String} [options.responseType] type of the response used by OAuth 2.0 flow. It can be any space separated list of the values `code`, `token`, `id_token`. {@link https://openid.net/specs/oauth-v2-multiple-response-types-1_0}
Expand Down Expand Up @@ -541,7 +541,7 @@ WebAuth.prototype.signup = function(options, cb) {
* After that, you'll have to use the {@link parseHash} function at the specified `redirectUri`.
*
* @method authorize
* @param {Object} options
* @param {Object} [options]
* @param {String} [options.clientID] the Client ID found on your Application settings page
* @param {String} options.redirectUri url that the Auth0 will redirect after Auth with the Authorization Response
* @param {String} options.responseType type of the response used by OAuth 2.0 flow. It can be any space separated list of the values `code`, `token`, `id_token`. {@link https://openid.net/specs/oauth-v2-multiple-response-types-1_0}
Expand Down Expand Up @@ -731,7 +731,7 @@ WebAuth.prototype.crossOriginVerification = function() {
* - If the client_id parameter is NOT included, the returnTo URL must be listed in the Allowed Logout URLs set at the account level (see Setting Allowed Logout URLs at the Account Level).
*
* @method logout
* @param {Object} options
* @param {Object} [options]
* @param {String} [options.clientID] the Client ID found on your Application settings page
* @param {String} [options.returnTo] URL to be redirected after the logout
* @param {Boolean} [options.federated] tells Auth0 if it should logout the user also from the IdP.
Expand Down