ForgeRock Server Info API

Retrieve server information and configuration

Operations 1

GET /am/json/realms/root/realms/{realm}/serverinfo/* ForgeRock Get server information #

Documentation

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/forgerock-server-info-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

forgerock-server-info-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ForgeRock Identity Cloud REST Server Info API
  description: REST API for managing identities, authentication, and authorization in ForgeRock Identity Cloud (PingOne Advanced Identity Cloud). Provides access management and identity management endpoints for Advanced Identity Cloud tenant environments, including authentication journeys, session management, managed object CRUD, OAuth 2.0 and OpenID Connect flows.
  version: 1.0.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: identity-cloud
servers:
- url: https://{tenant}.forgeblocks.com
  description: ForgeRock Identity Cloud tenant
  variables:
    tenant:
      default: mycompany
      description: The tenant identifier for your Identity Cloud environment
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Server Info
  description: Retrieve server information and configuration
paths:
  /am/json/realms/root/realms/{realm}/serverinfo/*:
    get:
      operationId: getServerInfo
      summary: ForgeRock Get server information
      description: Retrieve server information including supported features, cookie name, and realm configuration.
      tags:
      - Server Info
      parameters:
      - $ref: '#/components/parameters/RealmPath'
      responses:
        '200':
          description: Server information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerInfo'
components:
  parameters:
    RealmPath:
      name: realm
      in: path
      required: true
      description: The realm name (e.g., alpha, bravo)
      schema:
        type: string
        default: alpha
  schemas:
    ServerInfo:
      type: object
      description: Server configuration information
      properties:
        cookieName:
          type: string
          description: Name of the SSO cookie
        domains:
          type: array
          items:
            type: string
          description: Cookie domains
        protectedUserAttributes:
          type: array
          items:
            type: string
        forgotPassword:
          type: string
        selfRegistration:
          type: string
        lang:
          type: string
        successfulUserRegistrationDestination:
          type: string
        socialImplementations:
          type: array
          items:
            type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token obtained from the token endpoint. Required for access management and identity management operations.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for tenant read-only operations. Used together with x-api-secret header.