API Overview
LoginRadius APIs are organized into focused groups so you can move quickly from platform orientation to the exact endpoints your use case needs.
This API reference combines:
- high-level navigation by API family
- generated operation reference from the public OpenAPI specification
- optional group-level guides such as Introduction and Authorization pages where they have been authored
How the APIs are organized
The LoginRadius API surface is grouped into the following main areas:
- Authentication API for registration, login, user sessions, passwords, and core customer identity workflows
- Account API for account-level operations, roles, sessions, and account-specific security flows
- Single Sign-On API for OAuth, OIDC, JWT, SAML, machine-to-machine, and cross-device SSO use cases
- Analytics API for identity insights, custom objects, and analytics-oriented data retrieval
- Management API for platform configuration, providers, templates, security settings, workflows, webhooks, and administrative controls
- Partner IAM API for organizations, org roles, org connections, invitations, and partner-facing identity workflows
- Hosted Plugins API for plugin-specific integrations such as BigCommerce, Shopify, and PerfectMind SSO flows
Authentication models
Across the API families, LoginRadius uses a small set of authentication models:
- tenant-level API credentials such as API key and secret
- application credentials such as client ID and client secret
- bearer tokens for user or delegated access
- machine-to-machine bearer tokens for service-to-service flows
- signed request fields or headers for endpoints that require request integrity validation
The exact requirements vary by endpoint. Use the operation reference for endpoint-level details, and use a group Authorization page whenever one is available in the sidebar.
How to choose the right API family
Use this decision path:
- If you are building end-user sign-up, sign-in, password, or session flows, start with Authentication API
- If you are managing accounts, account sessions, or account-specific role models, start with Account API
- If you are implementing OAuth, OIDC, JWT, SAML, or cross-app SSO, start with Single Sign-On API
- If you need administrative configuration or platform setup, start with Management API
- If you are building organization-based partner IAM workflows, start with Partner IAM API
- If you are integrating hosted plugins, start with Hosted Plugins API
- If your goal is reporting, insights, or identity analytics, start with Analytics API
Recommended starting paths
- New customer identity implementation: start with Authentication API
- B2B / organization access model: start with Partner IAM API
- Enterprise federation and token flows: start with Single Sign-On API
- Tenant configuration and provider setup: start with Management API