Skip to main content

LoginRadius API Reference (beta)

Welcome to the LoginRadius OpenAPI Reference.
This documentation provides complete details of the LoginRadius Identity APIs, including endpoints, request/response structures, parameters, and error codes.

Overview

The LoginRadius API allows you to:

  • Authenticate and manage users
  • Enable registration and login flows
  • Implement password and passkey-based authentication
  • Configure MFA, roles, and permissions
  • Manage organizations, domains, and identity provider connections
  • Handle account linking, invitations, and migrations
  • Work with custom objects, fields, and templates

The reference is generated from the official OpenAPI 3.0.1 specification, ensuring accuracy and alignment with the platform’s latest capabilities.

Base URLs

The APIs are available through the following servers:

  • Production Server
    https://api.loginradius.com

  • Default Hosted Page Server
    https://{domain}.hub.loginradius.com
    Replace {domain} with your LoginRadius App Name.

  • Custom Domain Hosted by LoginRadius
    https://{customDomain}
    Replace {customDomain} with your configured custom domain.

Authentication

Most endpoints require one or more authentication mechanisms:

  • API Key
  • Client ID
  • Access Token

Refer to the endpoint details for the required security scheme.

Tags and Categories

APIs are grouped into functional categories, such as:

  • Registration & Login
  • User Management
  • Passwords & MFA
  • Roles & Permissions
  • Organizations & Connections
  • Social Login & Providers
  • Workflows & Webhooks
  • Migration & Insights

Use the sidebar to explore the APIs by category.

Example

Forgot Password

Endpoint:
POST /identity/v2/auth/password

This API triggers the password reset process using a username or email.

POST https://api.loginradius.com/identity/v2/auth/password