Auth0

Auth0 authentication integration for NativeScript apps.

Installation

npm install @nstudio/nativescript-auth0

Usage

Basic Setup

import { Auth0 } from '@nstudio/nativescript-auth0';

const auth0Client = new Auth0({
  clientId: '<your-client-id>',
  domain: '<your-domain>.auth0.com'
});

Web Authentication

Start the web authentication flow:

try {
  const credentials = await auth0Client.webAuth.start({
    scope: 'openid profile email',
    audience: 'https://your-api.com'
  });
  console.log('Access Token:', credentials.accessToken);
  console.log('ID Token:', credentials.idToken);
  console.log('Expires In:', credentials.expiresIn);
} catch (error) {
  console.error('Authentication failed:', error);
}

Advanced Options

You can customize the authentication flow with additional options:

const credentials = await auth0Client.webAuth.start({
  scope: 'openid profile email',
  audience: 'https://your-api.com',
  scheme: 'myapp',
  redirectUrl: 'myapp://callback',
  ephemeral: true, // iOS only: Use ephemeral browser session
  parameters: {
    // Additional platform-specific parameters
    login_hint: '[email protected]',
    ui_locales: 'es'
  }
});

Configuration

Get your credentials from the Auth0 Dashboard:

1. Create a new Application (Native type)
2. Note your Client ID and Domain
3. Configure your callback URLs

iOS Setup

Add your callback URL to App_Resources/iOS/Info.plist:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
    </array>
  </dict>
</array>

Android Setup

Add your callback URL scheme to your Android manifest or gradle configuration as needed.

API Reference

new Auth0(options)

Create a new Auth0 client instance.

Option	Type	Description
clientId	string	Your Auth0 Client ID
domain	string	Your Auth0 domain

auth0Client.webAuth.start(options?)

Start the web authentication flow. Returns a Promise with credentials.

Options

Option	Type	Platform	Description
scope	string	Both	OAuth scopes to request (e.g., 'openid profile email')
audience	string	Both	API identifier for which to request access
scheme	string	Both	Custom URL scheme for callback
redirectUrl	string	Both	Custom redirect URL
ephemeral	boolean	iOS	Use ephemeral browser session (doesn't persist cookies/data)
parameters	Record<string, string>	Both	Additional authentication parameters

Additional Parameters

The parameters option allows you to pass additional authentication parameters:

const credentials = await auth0Client.webAuth.start({
  parameters: {
    login_hint: '[email protected]',  // Pre-fill login email
    ui_locales: 'es',                // Set UI language
    prompt: 'login',                 // Force login prompt
    max_age: '3600',                 // Maximum authentication age
    connection: 'google-oauth2'      // Specify connection
  }
});

Credentials Response

interface Credentials {
  accessToken: string;
  idToken: string;
  expiresIn: number;
  tokenType: string;
  refreshToken?: string;
  scope?: string;
}

License

Apache License Version 2.0