canonical: https://jentic.com/apis/loginradius.com/loginradius

# LoginRadius API

Jentic publishes the only available OpenAPI specification for LoginRadius API, keeping it validated and agent-ready. LoginRadius is a customer identity and access management (CIAM) platform that exposes registration, login, password recovery, profile management, email verification, role management, and account administration operations. The spec covers 18 endpoints across the auth and manage namespaces, supporting both end-user flows (register, login, change password) and back-office tasks (look up account by uid, manage roles).

## For AI agents

Register users, authenticate with email and password, manage profiles and access tokens, and administer roles and accounts in LoginRadius CIAM.

## Scope

Does not handle SSO federation configuration, MFA enrolment beyond basic flows, or organisation/tenant directory structures - use for end-user authentication, profile management, and role administration only.

## Capabilities

- Register new users with POST `/identity/v2/auth/register` and capture custom profile fields
- Authenticate users via POST `/identity/v2/auth/login` and issue an access token
- Validate or invalidate an access token through `/identity/v2/auth/access_token` endpoints
- Initiate forgot-password and reset-password flows on `/identity/v2/auth/password`
- Verify a user email via GET `/identity/v2/auth/email/verify`
- Look up, update, or delete an account by uid through `/identity/v2/manage/account/{uid}`
- Create, list, and delete roles for role-based access control

## Use cases

### Email and Password Registration Flow

Register new users from a sign-up form via POST `/identity/v2/auth/register` and trigger an email verification with the spec's email-verify flow. The same payload accepts custom profile fields so onboarding metadata is captured at sign-up.

Example prompt: POST `/identity/v2/auth/register` with email='jane@example.com', password='S3cure!', and FirstName='Jane' to create the account.

### Token-based Login for SPAs

Authenticate single-page applications by calling POST `/identity/v2/auth/login` and storing the returned access token client-side. Each subsequent request validates the token via GET `/identity/v2/auth/access_token/validate` so backends can trust the bearer.

Example prompt: POST `/identity/v2/auth/login` with email and password, then call GET `/identity/v2/auth/access_token/validate` with the returned token.

### Self-service Password Reset

Allow users to recover access by initiating POST `/identity/v2/auth/password/forgot`, which emails a reset link, then completing PUT `/identity/v2/auth/password/reset` with the token and new password. This avoids manual support tickets for forgotten credentials.

Example prompt: POST `/identity/v2/auth/password/forgot` with email='jane@example.com' to send the reset email.

### Role-based Access Control Setup

Provision roles for a new application by calling POST `/identity/v2/manage/role` and listing them with GET `/identity/v2/manage/role.` Roles can later be attached to users via the manage account endpoints to enforce scoped access.

Example prompt: POST `/identity/v2/manage/role` with body Name='editor' to create the role.

### AI Agent User Provisioning via Jentic

An agent that handles HR onboarding can register new employee accounts in LoginRadius and assign them a starter role through Jentic. The API key stays in the vault so the agent never sees the secret.

Example prompt: Through Jentic, search 'register a new user', load the LoginRadius POST `/identity/v2/auth/register` operation, and execute it with the new hire's email.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/identity/v2/auth/register` | Register a new user |
| POST | `/identity/v2/auth/login` | Authenticate with email and password |
| GET | `/identity/v2/auth/access_token/validate` | Validate an access token |
| POST | `/identity/v2/auth/password/forgot` | Trigger forgot-password email |
| PUT | `/identity/v2/auth/password/reset` | Reset password with token |
| GET | `/identity/v2/manage/account/{uid}` | Look up an account by uid |
| POST | `/identity/v2/manage/role` | Create a new role |

## Key resources

- **Auth** — Register, login, access token validation, password reset, and email verification operations
- **Manage Account** — Look up, update, or delete accounts by uid; list account identities
- **Manage Role** — Create, list, and delete role-based access control roles

## Why Jentic

- **Setup:** Wiring the LoginRadius API by hand means setting up its X-API-Key header, managing the apikey and apisecret pair, and shaping registration, login, and account management request bodies against api.loginradius.com yourself. Through Jentic you install once, import LoginRadius from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** LoginRadius carries the target through request bodies and query parameters for its auth flows, so scoping is by operation: limit the agent to the operations it needs, such as registering a user or starting a password reset, and leave out account management or role administration if the agent only handles sign-up.
- **Credential handling:** Your LoginRadius apikey and apisecret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'register a user' or 'reset a password', and Jentic returns the matching LoginRadius operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0 Management API** — Mature CIAM platform with extensive enterprise SSO and rules support
- **Okta API** — Identity platform focused on workforce and customer identity at enterprise scale
- **Stytch API** — Modern passwordless and biometric-first authentication API
- **Clerk Backend API** — Developer-friendly auth with prebuilt React components and session management

## FAQ

### Why is there no official OpenAPI spec for LoginRadius API?

LoginRadius does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call LoginRadius API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the LoginRadius API use?

LoginRadius uses an API key passed as a query parameter (apikey). Manage endpoints additionally require an apisecret. Through Jentic both values are stored encrypted in the vault and injected at execution, never reaching the agent's context.

### Can I implement self-service password reset with the LoginRadius API?

Yes. Call POST `/identity/v2/auth/password/forgot` to email the user a reset link, then complete the flow with PUT `/identity/v2/auth/password/reset` using the token from the email.

### How do I register a new user through Jentic?

Run `pip install jentic`, search Jentic for 'register a new user', load the LoginRadius POST `/identity/v2/auth/register` operation, and execute it with the user's email and password. Jentic returns the new uid.

### What are the rate limits for the LoginRadius API?

Rate limits depend on your LoginRadius plan tier. The spec does not embed specific numbers. Implement exponential backoff on HTTP 429 responses to stay within quota.

### Can I manage user roles via the LoginRadius API?

Yes. Use POST `/identity/v2/manage/role` to create roles, GET `/identity/v2/manage/role` to list them, and DELETE `/identity/v2/manage/role/{roleName}` to remove a role.

### Can I limit what my agent is allowed to do with the LoginRadius API?

Yes. Because you run Jentic One yourself, your own rules decide which LoginRadius operations and credentials the agent may use, and LoginRadius scopes by operation since the target is carried in each request body and query parameter. If your agent only handles sign-up, you can allow just the register and password-reset operations, such as POST `/identity/v2/auth/register` and POST `/identity/v2/auth/password/forgot`, and leave out account management and role administration like GET `/identity/v2/manage/account/{uid}` and POST `/identity/v2/manage/role.` Your apikey and apisecret stay stored by your own instance and are injected at execution, so the agent only ever exercises the operations you permit.