Auth0 Quickstarts Documentation

repository·master·Indexed 18 days ago

https://github.com/auth0/docs

Documentation focusing on Auth0 Quickstarts, including guides for integrating Auth0 Analytics.js with Google and Facebook Analytics, implementing the Client Credentials Grant for non-interactive applications, and using the Authentication API for identity management via OIDC, OAuth 2.0, FAPI, and SAML.

Tokens
280.4K
Snippets
648
Records
1.2K
Agent score
62%

What's inside Auth0 Quickstarts

  1. Overview of the Login by Auth0 WordPress Plugin

    master

    The Login by Auth0 WordPress plugin integrates WordPress sites with an Auth0 account to provide centralized identity management. It enables Single Sign-on (SSO) across multiple instances and supports various authentication methods including Enterprise Directories (LDAP, AD, G Suite, Office365, SAML), over 30 Social Providers, and passwordless login.

    Key features include:

    • SSO between WordPress installs and other applications
    • A User Management Dashboard
    • Optional Multi-factor Authentication (MFA)
    • Optional Passwordless Authentication
    • Reporting and Analytics
  2. Overview of Architectural Design Sessions

    master
    Architectural Design Sessions are fixed-scope professional services projects designed to establish a foundational Auth0 platform architecture. The goal is to set up connectivity and configuration of your environment to meet organizational needs and enable technical solutions for pre-defined business scenarios using Auth0.
  3. Overview of the Auth0 Deploy CLI tool

    master

    The Auth0 Deploy CLI (auth0-deploy-cli) enables continuous integration and deployment (CI/CD) for Auth0 tenants. It allows you to import and export various Auth0 tenant configuration objects to manage your tenant settings as code.

    Supported configuration objects include:

    • Tenant settings
    • Rules (including secrets/settings)
    • Hooks and Hook Secrets
    • Connections and Custom databases
    • Clients/applications
    • Resource servers (APIs)
    • Pages
    • Email templates and providers
    • Guardian settings

    Supported methods for managing configuration:

    • Directory Structure: Export data to a predefined directory structure.
    • YAML Configuration: Use a YAML configuration file.
    • Programmatic Access: Call the tool programmatically within your own scripts.
    • Environment Variable Replacement: Use the tool to replace environment variables in your configurations.

    ::: warning This tool can be destructive to your Auth0 tenant. Always test the tool on a development tenant before applying changes to a production environment. :::

  4. Choose an Auth0 support plan

    master

    Auth0 provides different support levels based on your subscription plan:

    • Community Support: For free subscription plan customers. Access is limited to the Auth0 Community forums. Response times are not guaranteed.
    • Standard Support: For paid (non-Enterprise) customers or those in a trial period. Includes access to the Auth0 Community and the ticketed Support Center.
    • Enterprise Support: For Enterprise subscription customers. Includes extended support hours for outages, quicker response times, and access to the Customer Success Team.
    • Premier Support: An add-on for Enterprise customers providing the highest level of service, including phone support and a designated team of Developer Support Engineers.
    • Preferred Support: An Enterprise add-on that is no longer available for new purchases.
  5. Choose a Java SDK based on your application architecture

    master

    Auth0 provides several Java libraries depending on your framework and security requirements:

    • Java Servlet: Best for legacy applications or non-Spring Web MVC frameworks. It provides secured endpoints and allows programmatic interaction with a Principal object for GrantedAuthority checks.
    • Java Spring MVC: Use this for modern Spring/Spring Boot server-side MVC web applications if you do not want to use Spring Security.
    • Java Spring Security MVC: Use this for modern Spring/Spring Boot server-side MVC web applications when you want full integration with Spring Security.
    • Java Spring Security API: Best for headless APIs and SPA (Single-Page Application) backends. It validates JWTs from Auth0 on every API call to assert authentication.
  6. Explore Auth0 implementation resources

    master

    Auth0 provides several categories of resources to assist with different stages of the implementation lifecycle:

    Learning and Getting Started

    • Getting Started documentation: Learn Auth0 terminology and explore the Dashboard.
    • Get Started with Auth0 Video Series: Visual guides covering tenant configuration, user provisioning, authentication, authorization, and branding.
    • Architecture scenarios: High-level descriptions and tutorials for common patterns (e.g., Single-Page Applications calling an API).
    • Implementation guides: Detailed instructions for features like user management and Multi-Factor Authentication (MFA).
    • Auth0 Learn: Feature descriptions, industry case studies, and white papers.

    Development and Testing

    • Quickstarts: Small sample programs for implementing authentication, session management, profile updates, and logout.
    • Libraries and SDKs: Abstracted identity protocol implementations for various languages and frameworks.
    • API Explorers: Tools to test Authentication API and Management API calls before writing code.
    • Postman Collections: Pre-configured collections to dissect API calls using Postman.

    Operations and Support

    • Support Center: Manage subscriptions, file support tickets, and run production checks.
    • Status Dashboard: Check service availability and subscribe to status updates.
    • Monitoring and Logs: Integrate monitoring endpoints and manage log data for analysis and compliance.
    • Pre-launch advice: Tips and tools for planning a smooth production launch.
  7. Locate Management API v2 or Docs Hosting source

    master

    This repository primarily contains Quickstarts. For other documentation sources, refer to the following:

    • Docs Hosting Application: See the auth0-docs repository.
    • Management API v2 Documentation: These are generated from the api2 repository.

    Note: Access to these repositories typically requires team authorization.

    Most other documentation content is no longer hosted on GitHub and is managed via a private content management system.

  8. Explore Auth0 Identity Lab exercises

    master

    The Identity Labs consist of several progressive exercises covering different application architectures:

    • Lab 1: Web Sign-In: Focuses on standard web authentication flows.
    • Lab 2: Calling an API: Demonstrates how to use tokens to access protected resources.
    • Lab 3: Mobile Application: Covers authentication in native mobile environments.
    • Lab 4: Single-Page Application: Covers authentication patterns for SPAs.
  9. Authentication API Overview

    master

    The Authentication API manages user identity, including login, signup, logout, and API access. It supports multiple identity protocols:

    • OpenID Connect (OIDC)
    • OAuth 2.0
    • FAPI (Financial-grade API)
    • SAML

    All requests must be sent over HTTPS using the following base URL: https://${account.namespace}

    This API is designed for direct RESTful integration. For a more guided experience, use Auth0 Quickstarts or Libraries.

  10. Use Auth0 Professional Services for implementation

    master

    Auth0 offers Professional Services to accelerate integration, ensure operational readiness, and provide quality assurance. These services are categorized into three main engagement types:

    1. Programming Advisory: Accelerates development by providing best practice guidance on Auth0 SDKs, APIs, extensibility, and integration points. This includes receiving code samples and programming guidance tailored to your specific technology stack.
    2. Deployment Preparation: Focuses on validating an implemented solution before go-live. This includes reviewing integration (SDKs, APIs, extensibility) and the configuration of your Auth0 Tenant to ensure security and stability.
    3. Custom Implementation: Provides customized solutions for requirements that exceed standard out-of-the-box functionality. This includes:
      • In-product customizations: Custom rules, hooks, database scripts, login pages, and email templates to solve UX or 3rd-party integration logic within the Auth0 workflow.
      • Custom APIs and libraries: Custom web services or code libraries for service communication or tenant management (typically deployed on your own infrastructure).
      • Custom utilities: Tools for quality assurance or operations, such as performance testing or deployment scripts.
  11. What is the Bitbucket Deployments extension?

    master

    The Bitbucket Deployments extension enables automated deployment of Auth0 tenant configurations from a Bitbucket repository. By monitoring a specific branch in your repository, the extension can automatically deploy the following resources to Auth0 whenever changes are pushed:

    • Rules and Rules Configs
    • Database Connection scripts
    • Connections
    • Clients and Client Grants
    • Resource Servers
    • Universal Login pages
    • Email templates