Parameters:
diff --git a/docs/Management.html b/docs/Management.html index bbd0805d..0b5405ff 100644 --- a/docs/Management.html +++ b/docs/Management.html @@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/WebAuth.html b/docs/WebAuth.html index 744c1623..d7a3ab95 100644 --- a/docs/WebAuth.html +++ b/docs/WebAuth.html @@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/authentication_db-connection.js.html b/docs/authentication_db-connection.js.html index 33102404..019e5e6b 100644 --- a/docs/authentication_db-connection.js.html +++ b/docs/authentication_db-connection.js.html @@ -24,7 +24,7 @@
authentication/db-connection.js
diff --git a/docs/authentication_index.js.html b/docs/authentication_index.js.html index ca2af71f..deeb4827 100644 --- a/docs/authentication_index.js.html +++ b/docs/authentication_index.js.html @@ -24,7 +24,7 @@
authentication/index.js
diff --git a/docs/global.html b/docs/global.html index 78f6a891..9fc1b8fa 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
authorizeSource:
Parameters:
+
+
+
+
Parameters:
+ + + +callback()
+ + + + + +Runs the callback code for the cross origin authentication call. This method is meant to be called by the cross origin authentication callback url.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
- - - -callback()
- - - - - -Runs the callback code for the cross origin authentication call. This method is meant to be called by the cross origin authentication callback url.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
changeP
Source:
checkSess
Source:
Source:
Source:
linkUserSource:
login
- Logs the user in with username and password using the correct flow based on where it's called from:
-
-- If you're calling this method from the Universal Login Page, it will use the usernamepassword/login endpoint
-- If you're calling this method outside the Universal Login Page, it will use the cross origin authentication (/co/authenticate) flow
-You can use either
username or email to identify the user, but username will take precedence over email.
-After the redirect to redirectUri, use parseHash to retrieve the authentication data.
-Notice that when using the cross origin authentication flow, some browsers might not be able to successfully authenticate if 3rd party cookies are disabled. See here for more information..
-
+ Makes a call to the oauth/token endpoint with password-realm grant type
Source:
Source:
linkUserSource:
login
- Logs the user in with username and password using the correct flow based on where it's called from:
-
-- If you're calling this method from the Universal Login Page, it will use the usernamepassword/login endpoint
-- If you're calling this method outside the Universal Login Page, it will use the cross origin authentication (/co/authenticate) flow
-You can use either
username or email to identify the user, but username will take precedence over email.
-After the redirect to redirectUri, use parseHash to retrieve the authentication data.
-Notice that when using the cross origin authentication flow, some browsers might not be able to successfully authenticate if 3rd party cookies are disabled. See here for more information..
-
+ Makes a call to the oauth/token endpoint with password-realm grant type
linkUserSource:
login
- Logs the user in with username and password using the correct flow based on where it's called from:
-
-- If you're calling this method from the Universal Login Page, it will use the usernamepassword/login endpoint
-- If you're calling this method outside the Universal Login Page, it will use the cross origin authentication (/co/authenticate) flow
-You can use either
username or email to identify the user, but username will take precedence over email.
-After the redirect to redirectUri, use parseHash to retrieve the authentication data.
-Notice that when using the cross origin authentication flow, some browsers might not be able to successfully authenticate if 3rd party cookies are disabled. See here for more information..
-
+ Makes a call to the oauth/token endpoint with password-realm grant type
Logs the user in with username and password using the correct flow based on where it's called from:
--
-
- If you're calling this method from the Universal Login Page, it will use the usernamepassword/login endpoint -
- If you're calling this method outside the Universal Login Page, it will use the cross origin authentication (/co/authenticate) flow
-You can use either
usernameoremailto identify the user, butusernamewill take precedence overemail. -After the redirect toredirectUri, useparseHashto retrieve the authentication data. -Notice that when using the cross origin authentication flow, some browsers might not be able to successfully authenticate if 3rd party cookies are disabled. See here for more information..
-
Makes a call to the oauth/token endpoint with password-realm grant type
loginSource:
loginSee:
- Requires Implicit grant. For more information, read https://auth0.com/docs/clients/client-grant-types.
Requires http://auth0.com/oauth/grant-type/password-realm grant. For more information, read https://auth0.com/docs/clients/client-grant-types.
@@ -4365,7 +4358,7 @@ Parameters:
- options used in the authorize call after the login_ticket is acquired
+
@@ -4408,7 +4401,39 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+
+ email or username of the user that will perform Auth
+
+
+
+
+
+
+
+
+ password
+
+
+String
+
+
+
+
+
+
+
@@ -4420,7 +4445,7 @@ Parameters:
- Username (mutually exclusive with email)
+ the password of the user that will perform Auth
@@ -4429,7 +4454,7 @@ Parameters:
- emailscope
@@ -4456,7 +4481,7 @@ Parameters:
- Email (mutually exclusive with username)
+ scopes to be requested during Auth. e.g. openid email
@@ -4465,7 +4490,7 @@ Parameters:
- passwordaudience
@@ -4480,6 +4505,8 @@ Parameters:
+ <optional>
+
@@ -4490,7 +4517,7 @@ Parameters:
- Password
+ identifier of the resource server who will consume the access token issued after Auth
@@ -4505,7 +4532,7 @@ Parameters:
-String
+Object
@@ -4514,8 +4541,6 @@ Parameters:
- <optional>
-
@@ -4526,7 +4551,7 @@ Parameters:
- Realm used to authenticate the user, it can be a realm name or a database connection name
+ the HRD domain or the connection name where the user belongs to. e.g. Username-Password-Authentication
@@ -4549,7 +4574,7 @@ Parameters:
-crossOriginLoginCallback
+tokenCallback
@@ -4560,7 +4585,7 @@ Parameters:
- Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
+ function called with the result of the request
@@ -4598,7 +4623,9 @@ login
- Makes a call to the oauth/token endpoint with password-realm grant type
+ Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
+Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
+After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
-
-
Requires
Implicitgrant. For more information, read https://auth0.com/docs/clients/client-grant-types.
+ Requires
http://auth0.com/oauth/grant-type/password-realmgrant. For more information, read https://auth0.com/docs/clients/client-grant-types.
Parameters:
options used in the authorize call after the login_ticket is acquired
Parameters:
+ + + + +
email or username of the user that will perform Auth
+ +passwordString
+
+
+
+ Parameters:
Username (mutually exclusive with email)
+the password of the user that will perform Auth
Parameters:
emailscopeParameters:
Email (mutually exclusive with username)
+scopes to be requested during Auth. e.g. openid email
Parameters:
passwordaudienceParameters:
+ @@ -4490,7 +4517,7 @@
Parameters:
Password
+identifier of the resource server who will consume the access token issued after Auth
Parameters:
String
+Object
@@ -4514,8 +4541,6 @@ Parameters:
- @@ -4526,7 +4551,7 @@
Parameters:
Realm used to authenticate the user, it can be a realm name or a database connection name
+the HRD domain or the connection name where the user belongs to. e.g. Username-Password-Authentication
Parameters:
crossOriginLoginCallback
+tokenCallback
@@ -4560,7 +4585,7 @@ Parameters:
Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
function called with the result of the request
login
- Makes a call to the oauth/token endpoint with password-realm grant type
+ Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
+Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
+After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
oauth/token endpoint with password-realm grant typeusername or email to identify the user, but username will take precedence over email.
+Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
+After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.loginSource:
See:
-
-
- Requires http://auth0.com/oauth/grant-type/password-realm grant. For more information, read https://auth0.com/docs/clients/client-grant-types.
-
-
@@ -4702,7 +4722,7 @@ Parameters:
-
+ options used in the authorize call after the login_ticket is acquired
@@ -4745,39 +4765,7 @@ Parameters:
-
-
-
-
-
-
-
-
-
-
- email or username of the user that will perform Auth
-
-
-
-
-
-
-
-
- password
-
-
-String
-
-
-
-
-
-
-
+ <optional>
@@ -4789,7 +4777,7 @@ Parameters:
- the password of the user that will perform Auth
+ Username (mutually exclusive with email)
@@ -4798,7 +4786,7 @@ Parameters:
- scopeemail
@@ -4825,7 +4813,7 @@ Parameters:
- scopes to be requested during Auth. e.g. openid email
+ Email (mutually exclusive with username)
@@ -4834,7 +4822,7 @@ Parameters:
- audiencepassword
@@ -4849,8 +4837,6 @@ Parameters:
- <optional>
-
@@ -4861,7 +4847,7 @@ Parameters:
- identifier of the resource server who will consume the access token issued after Auth
+ Password
@@ -4876,7 +4862,7 @@ Parameters:
-Object
+String
@@ -4885,6 +4871,8 @@ Parameters:
+ <optional>
+
@@ -4895,7 +4883,7 @@ Parameters:
- the HRD domain or the connection name where the user belongs to. e.g. Username-Password-Authentication
+ Realm used to authenticate the user, it can be a realm name or a database connection name
@@ -4918,7 +4906,7 @@ Parameters:
-tokenCallback
+crossOriginLoginCallback
@@ -4929,7 +4917,7 @@ Parameters:
- function called with the result of the request
+ Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
@@ -4967,9 +4955,14 @@ login
- Performs authentication with username/email and password with a database connection
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or login.
+ Logs the user in with username and password using the correct flow based on where it's called from:
+
+- If you're calling this method from the Universal Login Page, it will use the usernamepassword/login endpoint
+- If you're calling this method outside the Universal Login Page, it will use the cross origin authentication (/co/authenticate) flow
+You can use either
username or email to identify the user, but username will take precedence over email.
+After the redirect to redirectUri, use parseHash to retrieve the authentication data.
+Notice that when using the cross origin authentication flow, some browsers might not be able to successfully authenticate if 3rd party cookies are disabled. See here for more information..
+
-
-
Requires
http://auth0.com/oauth/grant-type/password-realmgrant. For more information, read https://auth0.com/docs/clients/client-grant-types.
-
options used in the authorize call after the login_ticket is acquired
Parameters:
email or username of the user that will perform Auth
- -passwordString
-
-
-
- @@ -4789,7 +4777,7 @@
Parameters:
the password of the user that will perform Auth
+Username (mutually exclusive with email)
scopeemailParameters:
scopes to be requested during Auth. e.g. openid email
Email (mutually exclusive with username)
audiencepasswordParameters:
- @@ -4861,7 +4847,7 @@
Parameters:
identifier of the resource server who will consume the access token issued after Auth
+Password
Object
+String
@@ -4885,6 +4871,8 @@ Parameters:
+ @@ -4895,7 +4883,7 @@
Parameters:
the HRD domain or the connection name where the user belongs to. e.g. Username-Password-Authentication
Realm used to authenticate the user, it can be a realm name or a database connection name
tokenCallback
+crossOriginLoginCallback
@@ -4929,7 +4917,7 @@ Parameters:
function called with the result of the request
+Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
Performs authentication with username/email and password with a database connection
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or login.
Logs the user in with username and password using the correct flow based on where it's called from:
+-
+
- If you're calling this method from the Universal Login Page, it will use the usernamepassword/login endpoint +
- If you're calling this method outside the Universal Login Page, it will use the cross origin authentication (/co/authenticate) flow
+You can use either
usernameoremailto identify the user, butusernamewill take precedence overemail. +After the redirect toredirectUri, useparseHashto retrieve the authentication data. +Notice that when using the cross origin authentication flow, some browsers might not be able to successfully authenticate if 3rd party cookies are disabled. See here for more information..
+
loginSource:
See:
+
+
+ Requires Implicit grant. For more information, read https://auth0.com/docs/clients/client-grant-types.
+
+
@@ -5066,7 +5066,7 @@ Parameters:
-
+ options used in the authorize call after the login_ticket is acquired
@@ -5094,7 +5094,7 @@ Parameters:
- redirectUriusername
@@ -5121,7 +5121,7 @@ Parameters:
- url that the Auth0 will redirect after Auth with the Authorization Response
+ Username (mutually exclusive with email)
@@ -5130,7 +5130,7 @@ Parameters:
- responseTypeemail
@@ -5157,7 +5157,7 @@ Parameters:
- type of the response used. It can be any of the values code and token
+ Email (mutually exclusive with username)
@@ -5166,7 +5166,7 @@ Parameters:
- responseModepassword
@@ -5181,8 +5181,6 @@ Parameters:
- <optional>
-
@@ -5193,7 +5191,7 @@ Parameters:
- how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment
+ Password
@@ -5202,7 +5200,7 @@ Parameters:
- scoperealm
@@ -5229,7 +5227,7 @@ Parameters:
- scopes to be requested during AuthN. e.g. openid email
+ Realm used to authenticate the user, it can be a realm name or a database connection name
@@ -5252,7 +5250,7 @@ Parameters:
-credentialsCallback
+crossOriginLoginCallback
@@ -5263,7 +5261,7 @@ Parameters:
-
+ Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
@@ -5301,9 +5299,9 @@ login
- Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
-Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
-After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
+ Performs authentication with username/email and password with a database connection
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or login.
-
+
Requires
Implicitgrant. For more information, read https://auth0.com/docs/clients/client-grant-types.
+
options used in the authorize call after the login_ticket is acquired
Parameters:
redirectUriusernameParameters:
url that the Auth0 will redirect after Auth with the Authorization Response
+Username (mutually exclusive with email)
responseTypeemailParameters:
type of the response used. It can be any of the values code and token
Email (mutually exclusive with username)
responseModepasswordParameters:
- @@ -5193,7 +5191,7 @@
Parameters:
how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment
Password
scoperealmParameters:
scopes to be requested during AuthN. e.g. openid email
Realm used to authenticate the user, it can be a realm name or a database connection name
credentialsCallback
+crossOriginLoginCallback
@@ -5263,7 +5261,7 @@ Parameters:
Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
-Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
-After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
Performs authentication with username/email and password with a database connection
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or login.
loginSource:
Parameters:
- options used in the authorize call after the login_ticket is acquired
+
@@ -5428,7 +5426,7 @@ Parameters:
- usernameredirectUri
@@ -5455,7 +5453,7 @@ Parameters:
- Username (mutually exclusive with email)
+ url that the Auth0 will redirect after Auth with the Authorization Response
@@ -5464,7 +5462,7 @@ Parameters:
- emailresponseType
@@ -5491,7 +5489,7 @@ Parameters:
- Email (mutually exclusive with username)
+ type of the response used. It can be any of the values code and token
@@ -5500,7 +5498,7 @@ Parameters:
- passwordresponseMode
@@ -5515,6 +5513,8 @@ Parameters:
+ <optional>
+
@@ -5525,7 +5525,7 @@ Parameters:
- Password
+ how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment
@@ -5534,7 +5534,7 @@ Parameters:
- realmscope
@@ -5561,7 +5561,7 @@ Parameters:
- Realm used to authenticate the user, it can be a realm name or a database connection name
+ scopes to be requested during AuthN. e.g. openid email
@@ -5584,7 +5584,7 @@ Parameters:
-crossOriginLoginCallback
+credentialsCallback
@@ -5595,7 +5595,7 @@ Parameters:
- Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
+
@@ -5633,9 +5633,9 @@ l
- Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
-Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
-After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
+ Performs authentication with username/email and password with a database connection inside a new window
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or login.
@@ -5659,8 +5659,6 @@ l
- Deprecated: - This method will be released in the next major version. Use `webAuth.login` instead.
l
Source:
Parameters:
- options used in the authorize call after the login_ticket is acquired
+
@@ -5762,7 +5760,7 @@ Parameters:
- usernameredirectUri
@@ -5789,7 +5787,7 @@ Parameters:
- Username (mutually exclusive with email)
+ url that the Auth0 will redirect after Auth with the Authorization Response
@@ -5798,7 +5796,7 @@ Parameters:
- emailresponseType
@@ -5825,7 +5823,7 @@ Parameters:
- Email (mutually exclusive with username)
+ type of the response used. It can be any of the values code and token
@@ -5834,7 +5832,7 @@ Parameters:
- passwordresponseMode
@@ -5849,6 +5847,8 @@ Parameters:
+ <optional>
+
@@ -5859,7 +5859,7 @@ Parameters:
- Password
+ how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
@@ -5868,7 +5868,7 @@ Parameters:
- connectionscope
@@ -5895,7 +5895,7 @@ Parameters:
- Connection used to authenticate the user, it can be a realm name or a database connection name
+ scopes to be requested during AuthN. e.g. openid email
@@ -5918,7 +5918,7 @@ Parameters:
-crossOriginLoginCallback
+credentialsCallback
@@ -5929,7 +5929,7 @@ Parameters:
- Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
+
@@ -5967,9 +5967,9 @@ l
- Performs authentication with username/email and password with a database connection inside a new window
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or login.
+ Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
+Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
+After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
@@ -5993,6 +5993,8 @@ l
+ Deprecated: - This method will be released in the next major version. Use `webAuth.login` instead.
l
Source:
Parameters:
-
+ options used in the authorize call after the login_ticket is acquired
@@ -6094,7 +6096,7 @@ Parameters:
- redirectUriusername
@@ -6121,7 +6123,7 @@ Parameters:
- url that the Auth0 will redirect after Auth with the Authorization Response
+ Username (mutually exclusive with email)
@@ -6130,7 +6132,7 @@ Parameters:
- responseTypeemail
@@ -6157,7 +6159,7 @@ Parameters:
- type of the response used. It can be any of the values code and token
+ Email (mutually exclusive with username)
@@ -6166,7 +6168,7 @@ Parameters:
- responseModepassword
@@ -6181,8 +6183,6 @@ Parameters:
- <optional>
-
@@ -6193,7 +6193,7 @@ Parameters:
- how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
+ Password
@@ -6202,7 +6202,7 @@ Parameters:
- scopeconnection
@@ -6229,7 +6229,7 @@ Parameters:
- scopes to be requested during AuthN. e.g. openid email
+ Connection used to authenticate the user, it can be a realm name or a database connection name
@@ -6252,7 +6252,7 @@ Parameters:
-credentialsCallback
+crossOriginLoginCallback
@@ -6263,7 +6263,7 @@ Parameters:
-
+ Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
@@ -7042,7 +7042,7 @@ logoutSource:
pass
Source:
pass
Source:
pas
Source:
pas
Source:
Parameters:
+
options used in the authorize call after the login_ticket is acquired
Parameters:
usernameredirectUriParameters:
Username (mutually exclusive with email)
+url that the Auth0 will redirect after Auth with the Authorization Response
emailresponseTypeParameters:
Email (mutually exclusive with username)
+type of the response used. It can be any of the values code and token
passwordresponseModeParameters:
+ @@ -5525,7 +5525,7 @@
Parameters:
Password
+how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment
realmscopeParameters:
Realm used to authenticate the user, it can be a realm name or a database connection name
+scopes to be requested during AuthN. e.g. openid email
crossOriginLoginCallback
+credentialsCallback
@@ -5595,7 +5595,7 @@ Parameters:
Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
-Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
-After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
Performs authentication with username/email and password with a database connection inside a new window
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or login.
l
- Deprecated: - This method will be released in the next major version. Use `webAuth.login` instead.
l
Source:
Parameters:
- options used in the authorize call after the login_ticket is acquired
+
@@ -5762,7 +5760,7 @@ Parameters:
- usernameredirectUri
@@ -5789,7 +5787,7 @@ Parameters:
- Username (mutually exclusive with email)
+ url that the Auth0 will redirect after Auth with the Authorization Response
@@ -5798,7 +5796,7 @@ Parameters:
- emailresponseType
@@ -5825,7 +5823,7 @@ Parameters:
- Email (mutually exclusive with username)
+ type of the response used. It can be any of the values code and token
@@ -5834,7 +5832,7 @@ Parameters:
- passwordresponseMode
@@ -5849,6 +5847,8 @@ Parameters:
+ <optional>
+
@@ -5859,7 +5859,7 @@ Parameters:
- Password
+ how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
@@ -5868,7 +5868,7 @@ Parameters:
- connectionscope
@@ -5895,7 +5895,7 @@ Parameters:
- Connection used to authenticate the user, it can be a realm name or a database connection name
+ scopes to be requested during AuthN. e.g. openid email
@@ -5918,7 +5918,7 @@ Parameters:
-crossOriginLoginCallback
+credentialsCallback
@@ -5929,7 +5929,7 @@ Parameters:
- Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
+
@@ -5967,9 +5967,9 @@ l
- Performs authentication with username/email and password with a database connection inside a new window
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or login.
+ Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
+Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
+After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
@@ -5993,6 +5993,8 @@ l
+ Deprecated: - This method will be released in the next major version. Use `webAuth.login` instead.
l
Source:
Parameters:
-
+ options used in the authorize call after the login_ticket is acquired
@@ -6094,7 +6096,7 @@ Parameters:
- redirectUriusername
@@ -6121,7 +6123,7 @@ Parameters:
- url that the Auth0 will redirect after Auth with the Authorization Response
+ Username (mutually exclusive with email)
@@ -6130,7 +6132,7 @@ Parameters:
- responseTypeemail
@@ -6157,7 +6159,7 @@ Parameters:
- type of the response used. It can be any of the values code and token
+ Email (mutually exclusive with username)
@@ -6166,7 +6168,7 @@ Parameters:
- responseModepassword
@@ -6181,8 +6183,6 @@ Parameters:
- <optional>
-
@@ -6193,7 +6193,7 @@ Parameters:
- how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
+ Password
@@ -6202,7 +6202,7 @@ Parameters:
- scopeconnection
@@ -6229,7 +6229,7 @@ Parameters:
- scopes to be requested during AuthN. e.g. openid email
+ Connection used to authenticate the user, it can be a realm name or a database connection name
@@ -6252,7 +6252,7 @@ Parameters:
-credentialsCallback
+crossOriginLoginCallback
@@ -6263,7 +6263,7 @@ Parameters:
-
+ Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
@@ -7042,7 +7042,7 @@ logoutSource:
pass
Source:
pass
Source:
pas
Source:
pas
Source:
Parameters:
+
- This method will be released in the next major version. Use `webAuth.login` instead.
Parameters:
options used in the authorize call after the login_ticket is acquired
Parameters:
usernameredirectUriParameters:
Username (mutually exclusive with email)
+url that the Auth0 will redirect after Auth with the Authorization Response
Parameters:
emailresponseTypeParameters:
Email (mutually exclusive with username)
+type of the response used. It can be any of the values code and token
Parameters:
passwordresponseModeParameters:
+ @@ -5859,7 +5859,7 @@
Parameters:
Password
+how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
Parameters:
connectionscopeParameters:
Connection used to authenticate the user, it can be a realm name or a database connection name
+scopes to be requested during AuthN. e.g. openid email
Parameters:
crossOriginLoginCallback
+credentialsCallback
@@ -5929,7 +5929,7 @@ Parameters:
Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
l
- Performs authentication with username/email and password with a database connection inside a new window
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or login.
+ Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
+Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
+After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
@@ -5993,6 +5993,8 @@ l
+ Deprecated: - This method will be released in the next major version. Use `webAuth.login` instead.
l
Source:
Parameters:
-
+ options used in the authorize call after the login_ticket is acquired
@@ -6094,7 +6096,7 @@ Parameters:
- redirectUriusername
@@ -6121,7 +6123,7 @@ Parameters:
- url that the Auth0 will redirect after Auth with the Authorization Response
+ Username (mutually exclusive with email)
@@ -6130,7 +6132,7 @@ Parameters:
- responseTypeemail
@@ -6157,7 +6159,7 @@ Parameters:
- type of the response used. It can be any of the values code and token
+ Email (mutually exclusive with username)
@@ -6166,7 +6168,7 @@ Parameters:
- responseModepassword
@@ -6181,8 +6183,6 @@ Parameters:
- <optional>
-
@@ -6193,7 +6193,7 @@ Parameters:
- how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
+ Password
@@ -6202,7 +6202,7 @@ Parameters:
- scopeconnection
@@ -6229,7 +6229,7 @@ Parameters:
- scopes to be requested during AuthN. e.g. openid email
+ Connection used to authenticate the user, it can be a realm name or a database connection name
@@ -6252,7 +6252,7 @@ Parameters:
-credentialsCallback
+crossOriginLoginCallback
@@ -6263,7 +6263,7 @@ Parameters:
-
+ Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
@@ -7042,7 +7042,7 @@ logoutSource:
pass
Source:
pass
Source:
pas
Source:
pas
Source:
Parameters:
+
Performs authentication with username/email and password with a database connection inside a new window
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or login.
Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.
+Some browsers might not be able to successfully authenticate if 3rd party cookies are disabled in your browser. See here for more information..
+After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.
- This method will be released in the next major version. Use `webAuth.login` instead.
l
Source:
Parameters:
-
+ options used in the authorize call after the login_ticket is acquired
@@ -6094,7 +6096,7 @@ Parameters:
- redirectUriusername
@@ -6121,7 +6123,7 @@ Parameters:
- url that the Auth0 will redirect after Auth with the Authorization Response
+ Username (mutually exclusive with email)
@@ -6130,7 +6132,7 @@ Parameters:
- responseTypeemail
@@ -6157,7 +6159,7 @@ Parameters:
- type of the response used. It can be any of the values code and token
+ Email (mutually exclusive with username)
@@ -6166,7 +6168,7 @@ Parameters:
- responseModepassword
@@ -6181,8 +6183,6 @@ Parameters:
- <optional>
-
@@ -6193,7 +6193,7 @@ Parameters:
- how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
+ Password
@@ -6202,7 +6202,7 @@ Parameters:
- scopeconnection
@@ -6229,7 +6229,7 @@ Parameters:
- scopes to be requested during AuthN. e.g. openid email
+ Connection used to authenticate the user, it can be a realm name or a database connection name
@@ -6252,7 +6252,7 @@ Parameters:
-credentialsCallback
+crossOriginLoginCallback
@@ -6263,7 +6263,7 @@ Parameters:
-
+ Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
@@ -7042,7 +7042,7 @@ logoutSource:
pass
Source:
pass
Source:
pas
Source:
pas
Source:
Parameters:
+
options used in the authorize call after the login_ticket is acquired
Parameters:
redirectUriusernameParameters:
url that the Auth0 will redirect after Auth with the Authorization Response
+Username (mutually exclusive with email)
responseTypeemailParameters:
type of the response used. It can be any of the values code and token
Email (mutually exclusive with username)
responseModepasswordParameters:
- @@ -6193,7 +6193,7 @@
Parameters:
how the AuthN response is encoded and redirected back to the client. Supported values are query and fragment. The query value is only supported when responseType is code.
Password
scopeconnectionParameters:
scopes to be requested during AuthN. e.g. openid email
Connection used to authenticate the user, it can be a realm name or a database connection name
credentialsCallback
+crossOriginLoginCallback
@@ -6263,7 +6263,7 @@ Parameters:
Callback function called only when an authentication error, like invalid username or password, occurs. For other types of errors, there will be a redirect to the redirectUri.
pass
Source:
pass
Source:
pas
Source:
pas
Source:
Parameters:
+
pas
Source:
pas
Source:
Parameters:
+
Parameters:
+patchUserAttributes(userId, user, cb)
+ + + + + +Updates the user attributes. It will patch the user attributes that the server allows it.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
userId |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+ + + + | +
user |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+
+ + + + | +
cb |
+
+
+
+
+
+userCallback
+
+
+
+ |
+
+
+
+
+
+ + + + | +
renewAuthSource:
signupSource:
sig
Source:
signupA
Signs up a new user and automatically logs the user in after the signup.
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or signupAndAuthorize.
@@ -10855,7 +11051,7 @@ signupA
Source:
signupA
Signs up a new user and automatically logs the user in after the signup.
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or signupAndAuthorize.
@@ -11385,7 +11579,7 @@ signupA
Source:
Source:
Source:
Parameters:
diff --git a/docs/index.html b/docs/index.html
index 331ca877..198a72d7 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -70,12 +70,12 @@ Index
Install
From CDN:
<!-- Latest patch release -->
-<script src="https://cdn.auth0.com/js/auth0/9.10.4/auth0.min.js"></script>
From npm:
+<script src="https://cdn.auth0.com/js/auth0/9.11.0/auth0.min.js"></script>From npm:
npm install auth0-js
After installing the auth0-js module, you'll need bundle it up along with all of its dependencies.
auth0.WebAuth
Provides support for all the authentication flows.
Initialize
var auth0 = new auth0.WebAuth({
- domain: "{YOUR_AUTH0_DOMAIN}",
- clientID: "{YOUR_AUTH0_CLIENT_ID}"
+ domain: '{YOUR_AUTH0_DOMAIN}',
+ clientID: '{YOUR_AUTH0_CLIENT_ID}'
});
Parameters:
- domain {REQUIRED, string}: Your Auth0 account domain such as
'example.auth0.com' or 'example.eu.auth0.com'.
@@ -120,12 +120,15 @@ API
- checkSession(options, callback): Allows you to acquire a new token from Auth0 for a user who already has an SSO session established against Auth0 for your domain. If the user is not authenticated, the authentication result will be empty and you'll receive an error like this:
{error: 'login_required'}.The method accepts any valid OAuth2 parameters that would normally be sent to /authorize.
Everything happens inside an iframe, so it will not reload your application or redirect away from it.
-
auth0.checkSession({
- audience: 'https://mystore.com/api/v2',
- scope: 'read:order write:order'
- }, function (err, authResult) {
+auth0.checkSession(
+ {
+ audience: 'https://mystore.com/api/v2',
+ scope: 'read:order write:order'
+ },
+ function(err, authResult) {
// Authentication tokens or error
-});
The contents of authResult are identical to those returned by parseHash().
+ }
+);
The contents of authResult are identical to those returned by parseHash().
Important: If you're not using the hosted login page to do social logins, you have to use your own social connection keys. If you use Auth0's dev keys, you'll always get login_required as an error when calling checkSession.
@@ -136,19 +139,22 @@ API
- client.login(options, callback): Authenticates a user with username and password in a realm using
/oauth/token. This will not initialize a SSO session at Auth0, hence can not be used along with silent authentication.
-
auth0.client.login({
- realm: 'Username-Password-Authentication', //connection name or HRD domain
- username: 'info@auth0.com',
- password: 'areallystrongpassword',
- audience: 'https://mystore.com/api/v2',
- scope: 'read:order write:order',
- }, function(err, authResult) {
+auth0.client.login(
+ {
+ realm: 'Username-Password-Authentication', //connection name or HRD domain
+ username: 'info@auth0.com',
+ password: 'areallystrongpassword',
+ audience: 'https://mystore.com/api/v2',
+ scope: 'read:order write:order'
+ },
+ function(err, authResult) {
// Auth tokens in the result or an error
-});
The contents of authResult are identical to those returned by parseHash().
+ }
+);
The contents of authResult are identical to those returned by parseHash().
auth0.Authentication
Provides an API client for the Auth0 Authentication API.
Initialize
var auth0 = new auth0.Authentication({
- domain: "{YOUR_AUTH0_DOMAIN}",
- clientID: "{YOUR_AUTH0_CLIENT_ID}"
+ domain: '{YOUR_AUTH0_DOMAIN}',
+ clientID: '{YOUR_AUTH0_CLIENT_ID}'
});
API
- buildAuthorizeUrl(options): Builds and returns the
/authorize url in order to initialize a new authN/authZ transaction. https://auth0.com/docs/api/authentication#database-ad-ldap-passive-
- buildLogoutUrl(options): Builds and returns the Logout url in order to initialize a new authN/authZ transaction. https://auth0.com/docs/api/authentication#logout
@@ -159,11 +165,12 @@ Initialize
var auth0 = new
auth0.Management
Provides an API Client for the Auth0 Management API (only methods meant to be used from the client with the user token). You should use an access_token with the https://YOUR_DOMAIN.auth0.com/api/v2/ audience to make this work. For more information, read the user management section of the Auth0.js documentation.
Initialize
var auth0 = new auth0.Management({
- domain: "{YOUR_AUTH0_DOMAIN}",
- token: "{ACCESS_TOKEN_FROM_THE_USER}"
+ domain: '{YOUR_AUTH0_DOMAIN}',
+ token: '{ACCESS_TOKEN_FROM_THE_USER}'
});
API
- getUser(userId, cb): Returns the user profile. https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id
- patchUserMetadata(userId, userMetadata, cb): Updates the user metadata. It will patch the user metadata with the attributes sent. https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id
+- patchUserAttributes(userId, user, cb): Updates the user attributes. It will patch the root attributes that the server allows it. To check what attributes can be patched, go to https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id
- linkUser(userId, secondaryUserToken, cb): Link two users. https://auth0.com/docs/api/management/v2#!/Users/post_identities
Documentation
For a complete reference and examples please check our docs.
@@ -191,7 +198,7 @@ License
signupSource:
sig
Source:
signupA
Signs up a new user and automatically logs the user in after the signup.
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or signupAndAuthorize.
@@ -10855,7 +11051,7 @@ signupA
Source:
signupA
Signs up a new user and automatically logs the user in after the signup.
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or signupAndAuthorize.
@@ -11385,7 +11579,7 @@ signupA
Source:
signupA
Signs up a new user and automatically logs the user in after the signup.
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or signupAndAuthorize.
@@ -10855,7 +11051,7 @@ signupA
Source:
signupA
Signs up a new user and automatically logs the user in after the signup.
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or signupAndAuthorize.
@@ -11385,7 +11579,7 @@ signupA
Source:
Signs up a new user and automatically logs the user in after the signup.
+This method is not compatible with API Auth so if you need to fetch API tokens with audience
+you should use authorize or signupAndAuthorize.
signupA
Signs up a new user and automatically logs the user in after the signup.
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or signupAndAuthorize.
@@ -11385,7 +11579,7 @@ signupA
Source:
Signs up a new user and automatically logs the user in after the signup.
-This method is not compatible with API Auth so if you need to fetch API tokens with audience
-you should use authorize or signupAndAuthorize.
Parameters:
diff --git a/docs/index.html b/docs/index.html index 331ca877..198a72d7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
Index
Install
From CDN:
<!-- Latest patch release -->
-<script src="https://cdn.auth0.com/js/auth0/9.10.4/auth0.min.js"></script>From npm:
+<script src="https://cdn.auth0.com/js/auth0/9.11.0/auth0.min.js"></script>From npm:
npm install auth0-jsAfter installing the auth0-js module, you'll need bundle it up along with all of its dependencies.
auth0.WebAuth
Provides support for all the authentication flows.
Initialize
var auth0 = new auth0.WebAuth({
- domain: "{YOUR_AUTH0_DOMAIN}",
- clientID: "{YOUR_AUTH0_CLIENT_ID}"
+ domain: '{YOUR_AUTH0_DOMAIN}',
+ clientID: '{YOUR_AUTH0_CLIENT_ID}'
});Parameters:
- domain {REQUIRED, string}: Your Auth0 account domain such as
'example.auth0.com'or'example.eu.auth0.com'.
@@ -120,12 +120,15 @@ - checkSession(options, callback): Allows you to acquire a new token from Auth0 for a user who already has an SSO session established against Auth0 for your domain. If the user is not authenticated, the authentication result will be empty and you'll receive an error like this:
{error: 'login_required'}.The method accepts any valid OAuth2 parameters that would normally be sent to/authorize. Everything happens inside an iframe, so it will not reload your application or redirect away from it.
API
auth0.checkSession({
- audience: 'https://mystore.com/api/v2',
- scope: 'read:order write:order'
- }, function (err, authResult) {
+auth0.checkSession(
+ {
+ audience: 'https://mystore.com/api/v2',
+ scope: 'read:order write:order'
+ },
+ function(err, authResult) {
// Authentication tokens or error
-});
The contents of authResult are identical to those returned by parseHash().
+ }
+);The contents of authResult are identical to those returned by parseHash().
@@ -136,19 +139,22 @@Important: If you're not using the hosted login page to do social logins, you have to use your own social connection keys. If you use Auth0's dev keys, you'll always get
login_requiredas an error when callingcheckSession.
API
- client.login(options, callback): Authenticates a user with username and password in a realm using
/oauth/token. This will not initialize a SSO session at Auth0, hence can not be used along with silent authentication.
auth0.client.login({
- realm: 'Username-Password-Authentication', //connection name or HRD domain
- username: 'info@auth0.com',
- password: 'areallystrongpassword',
- audience: 'https://mystore.com/api/v2',
- scope: 'read:order write:order',
- }, function(err, authResult) {
+auth0.client.login(
+ {
+ realm: 'Username-Password-Authentication', //connection name or HRD domain
+ username: 'info@auth0.com',
+ password: 'areallystrongpassword',
+ audience: 'https://mystore.com/api/v2',
+ scope: 'read:order write:order'
+ },
+ function(err, authResult) {
// Auth tokens in the result or an error
-});
The contents of authResult are identical to those returned by parseHash().
+ }
+);The contents of authResult are identical to those returned by parseHash().
auth0.Authentication
Provides an API client for the Auth0 Authentication API.
Initialize
var auth0 = new auth0.Authentication({
- domain: "{YOUR_AUTH0_DOMAIN}",
- clientID: "{YOUR_AUTH0_CLIENT_ID}"
+ domain: '{YOUR_AUTH0_DOMAIN}',
+ clientID: '{YOUR_AUTH0_CLIENT_ID}'
});API
- buildAuthorizeUrl(options): Builds and returns the
/authorizeurl in order to initialize a new authN/authZ transaction. https://auth0.com/docs/api/authentication#database-ad-ldap-passive- - buildLogoutUrl(options): Builds and returns the Logout url in order to initialize a new authN/authZ transaction. https://auth0.com/docs/api/authentication#logout @@ -159,11 +165,12 @@
Initialize
var auth0 = new
auth0.Management
Provides an API Client for the Auth0 Management API (only methods meant to be used from the client with the user token). You should use an access_token with the https://YOUR_DOMAIN.auth0.com/api/v2/ audience to make this work. For more information, read the user management section of the Auth0.js documentation.
Initialize
var auth0 = new auth0.Management({
- domain: "{YOUR_AUTH0_DOMAIN}",
- token: "{ACCESS_TOKEN_FROM_THE_USER}"
+ domain: '{YOUR_AUTH0_DOMAIN}',
+ token: '{ACCESS_TOKEN_FROM_THE_USER}'
});
API
- getUser(userId, cb): Returns the user profile. https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id
- patchUserMetadata(userId, userMetadata, cb): Updates the user metadata. It will patch the user metadata with the attributes sent. https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id
+- patchUserAttributes(userId, user, cb): Updates the user attributes. It will patch the root attributes that the server allows it. To check what attributes can be patched, go to https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id
- linkUser(userId, secondaryUserToken, cb): Link two users. https://auth0.com/docs/api/management/v2#!/Users/post_identities
Documentation
For a complete reference and examples please check our docs.
@@ -191,7 +198,7 @@ License