AuthHero API Reference

This document provides a reference for the AuthHero API.

Authentication Methods

Login

await authHero.login(options);

Initiates the login process for a user.

Parameters:

• options: An object with the following properties:
  • email: The user's email address
  • password: The user's password
  • connection: The connection to use for authentication

Returns:

A promise that resolves to a token response object.

Signup

await authHero.signup(options);

Registers a new user.

Parameters:

• options: An object with the following properties:
  • email: The user's email address
  • password: The user's password
  • connection: The connection to use for registration
  • user_metadata: Optional metadata for the user

Returns:

A promise that resolves to a user object.

Token Methods

Validate Token

await authHero.validateToken(token);

Validates a JWT token.

Parameters:

• token: The JWT token to validate

Returns:

A promise that resolves to a decoded token payload if valid, or throws an error if invalid.

Refresh Token

await authHero.refreshToken(refreshToken);

Refreshes an access token using a refresh token.

Parameters:

• refreshToken: The refresh token

Returns:

A promise that resolves to a new token response object.

Further Reference

For management API details (users, tenants, applications, connections, domains), see the Management API and Adapter Interfaces documentation.