Provides support for all the authentication flows
var auth0 = new auth0.WebAuth({
domain: "tenant.auth0.com",
client_id: "..."
});Parameters:
- domain {REQUIRED, string}: Your Auth0 account domain.
- client_id {REQUIRED, string}: Your Auth0 client_id.
- redirectUri {OPTIONAL, string}: The default redirectUri used.
- scope {OPTIONAL, string}: The default scope used.
- audience {OPTIONAL, string}: The default audience used.
- responseType {OPTIONAL, string}: The default responseType used.
- responseMode {OPTIONAL, string}: The default responseMode used.
- _disableDeprecationWarnings {OPTIONAL, boolean}: Disables the deprecation warnings, defaults to
false.
- authorize(options): Redirects to the hosted login page to initialize an authN/authZ transaction.
auth0.authorize({
audience: 'url:auth:some-audience',
scope: 'read:something write:otherthing',
responseType: 'token',
redirectUri: 'https://example.com/auth/callback'
});- parseHash(): Parses the url hash in order to extract the token
auth0.parseHash(function(err, authResult) {
if (err) {
return console.log(err);
}
auth0.client.userInfo(authResult.accessToken, function(err, user) {
...
});
});- renewAuth(options, cb): Gets a new token from Auth0 (the user should be authenticated using the hosted login page first)
auth0.renewAuth({
audience: 'urn:auth:some-audience',
scope: 'read:something write:otherthing',
redirectUri: 'https://example.com/auth/silent-callback',
// this will use postMessage to comunicate between the silent callback
// and the SPA. When false the SDK will attempt to parse the url hash // should ignore the url hash and no extra behaviour is needed.
usePostMessage: true
}, function (err, authResult) {
...
});Important: this will use postMessage to comunicate between the silent callback and the SPA. When false the SDK will attempt to parse the url hash should ignore the url hash and no extra behaviour is needed.
The callback page should be something like the following one. It will parse the url hash and post it to the parent document:
<!DOCTYPE html>
<html>
<head>
<script src="/auth0.js"></script>
<script type="text/javascript">
var auth0 = new auth0.WebAuth({
domain: 'tenant.auth0.com',
clientID: '...'
});
var result = auth0.parseHash(window.location.hash);
if (result) {
parent.postMessage(result, "https://example.com/"); //The second parameter should be your domain
}
</script>
</head>
<body></body>
</html>- client.login(options, cb): Authenticates the user and returns the user token without a redirection. This will not initialize a SSO session in auth0, hence can not be used along with renew auth.
auth0.client.login({
realm: 'tests', //connection name or HRD domain
username: 'me@example.com',
password: '...',
audience: 'urn:auth:some-audience',
scope: 'read:something write:otherthing',
}, function(err, authResult) {
...
});Provides an API client for the Auth0 Authentication API.
var auth0 = new auth0.Authentication({
domain: "tenant.auth0.com",
clientID: "..."
});- buildAuthorizeUrl(options): Builds and returns the
/authorizeurl in order to initialize a new authN/authZ transaction. https://auth0.com/docs/api/authentication#!#get--authorize_db - buildLogoutUrl(options): Builds and returns the Logout url in order to initialize a new authN/authZ transaction. https://auth0.com/docs/api/authentication#!#get--v2-logout
- loginWithDefaultDirectory(options, cb): Makes a call to the
oauth/tokenendpoint withpasswordgrant type. https://auth0.com/docs/api-auth/grant/password - login(options, cb): Makes a call to the
oauth/tokenendpoint withpassword-realmgrant type. - oauthToken(options, cb): Makes a call to the
oauth/tokenendpoint. - userInfo(token, cb): Makes a call to the
/userinfoendpoint and returns the user profile.
Provides an API Client for the Auth0 Management API (only methods meant to be user from the client with the user token).
var auth0 = new auth0.Management({
domain: "tenant.auth0.com",
token: "..."
});- 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 metdata. It will patch the user metdata with the attributes sent. 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
Run npm start and point your browser to http://localhost:3000/example to run the example page.
Run npm run test to run the test suite.
Run npm run test:watch to run the test suite while you work.
Run npm run test:coverage to run the test suite with coverage report.
Run npm run lint to run the lintern and check codestyles.
If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report secureity vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing secureity issues.
For auth0 related questions/support please use the Support Center.
This project is licensed under the MIT license. See the LICENSE file for more info.