How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ForgeRock Authentication API

Authenticate users via authentication trees and modules

ForgeRock Authentication API is one of 38 APIs that ForgeRock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and a changelog.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 7.3.0.

Requests are made against a single base URL, https://{deployment}/am.

2 operations 2 paths 7 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
7.3.0
Base URL
https://{tenant}.forgeblocks.com
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

ForgeRock Authentication API declares 2 security schemes for authenticating requests. An API key is passed in the header as iPlanetDirectoryPro (ssoToken). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • ssoToken — AM SSO token obtained from authentication
  • bearerAuth — OAuth 2.0 access token

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 2

Authenticate users via authentication trees and modules

POST
/json/realms/root/realms/{realm}/authenticate
ForgeRock Authenticate a user
authenticate 4 params body → 200401
POST
/am/json/realms/root/realms/{realm}/authenticate
ForgeRock Authenticate a user
authenticateUser 4 params body → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are AuthenticationResponse (5 properties), AuthenticationResponse_2 (5 properties), ErrorResponse (3 properties), Callback (3 properties). Each schema is shown below with its type and property counts.

AuthenticationResponse_2
object
Authentication step result
5 properties
ErrorResponse_2
object
Standard error response
3 properties
AuthenticationCallbackRequest
object
Authentication callback response from client
2 properties
AuthenticationRequest
object
Authentication callback response payload
2 properties
Callback
object
An authentication callback
3 properties
ErrorResponse
object
Standard CREST error response
3 properties
AuthenticationResponse
object
Authentication step or success result
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

forgerock-authentication-api-openapi.yml Raw ↑

Other APIs ForgeRock publishes across the network.

ForgeRock Access Requests API
ForgeRock Access Reviews API
ForgeRock Analytics API
ForgeRock Applications API
ForgeRock Audit API
ForgeRock Certifications API
ForgeRock Company View API
ForgeRock Configuration API
ForgeRock Entitlements API
ForgeRock Entries API
ForgeRock Groups API
ForgeRock Health API
Where this information came from

This is an independent, third-party profile of ForgeRock Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.