auth0
v4.11.0
Published
SDK for Auth0 API v2
Downloads
2,404,252
Maintainers
Readme
📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback
Documentation
- Docs Site - explore our docs site and learn more about Auth0
Getting Started
Requirements
This library supports the following tooling versions:
- Node.js:
>=18
Installation
Using npm in your project directory run the following command:
npm install auth0
Configure the SDK
Authentication API Client
This client can be used to access Auth0's Authentication API.
import { AuthenticationClient } from 'auth0';
const auth0 = new AuthenticationClient({
domain: '{YOUR_ACCOUNT}.auth0.com',
clientId: '{OPTIONAL_CLIENT_ID}',
clientSecret: '{OPTIONAL_CLIENT_SECRET}',
});
See more examples.
Management API Client
The Auth0 Management API is meant to be used by back-end servers or trusted parties performing administrative tasks. Generally speaking, anything that can be done through the Auth0 dashboard (and more) can also be done through this API.
Initialize your client class with a client ID, client secret and a domain.
import { ManagementClient } from 'auth0';
var management = new ManagementClient({
domain: '{YOUR_TENANT_AND REGION}.auth0.com',
clientId: '{YOUR_CLIENT_ID}',
clientSecret: '{YOUR_CLIENT_SECRET}',
});
Or, initialize your client class with an API v2 token and a domain.
import { ManagementClient } from 'auth0';
var management = new ManagementClient({
domain: '{YOUR_TENANT_AND REGION}.auth0.com',
token: '{YOUR_API_V2_TOKEN}',
});
See more examples.
API Reference
Feedback
Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
Raise an issue
To provide feedback or report a bug, please raise an issue on our issue tracker.
Vulnerability Reporting
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.