ForgeRock Configuration API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Configuration API
  description: REST API for ForgeRock Access Management (AM) providing authentication, authorization, session management, and policy evaluation. Supports OAuth 2.0 and OpenID Connect flows, authentication trees/journeys, policy-based authorization decisions, and realm management.
  version: 7.3.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: access-management
servers:
- url: https://{deployment}/am
  description: ForgeRock Access Management server
  variables:
    deployment:
      default: am.example.com
      description: The AM deployment hostname
security:
- ssoToken: []
- bearerAuth: []
tags:
- name: Configuration
  description: Read and update IDM configuration
paths:
  /config:
    get:
      operationId: listConfigurations
      summary: ForgeRock List configuration objects
      description: List all IDM configuration objects stored in the repository.
      tags:
      - Configuration
      responses:
        '200':
          description: List of configuration object identifiers
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurations:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        pid:
                          type: string
                        factoryPid:
                          type: string
  /config/{configId}:
    get:
      operationId: getConfiguration
      summary: ForgeRock Get a configuration object
      description: Retrieve a specific configuration object by its identifier (e.g., managed, sync, router, audit).
      tags:
      - Configuration
      parameters:
      - name: configId
        in: path
        required: true
        description: Configuration object identifier (e.g., managed, sync, audit)
        schema:
          type: string
      responses:
        '200':
          description: The configuration object
          content:
            application/json:
              schema:
                type: object
        '404':
          description: Configuration not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: updateConfiguration
      summary: ForgeRock Update a configuration object
      description: Replace an entire configuration object.
      tags:
      - Configuration
      parameters:
      - name: configId
        in: path
        required: true
        description: Configuration object identifier
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Configuration updated
          content:
            application/json:
              schema:
                type: object
    delete:
      operationId: deleteConfiguration
      summary: ForgeRock Delete a configuration object
      description: Delete a configuration object by identifier.
      tags:
      - Configuration
      parameters:
      - name: configId
        in: path
        required: true
        description: Configuration object identifier
        schema:
          type: string
      responses:
        '200':
          description: Configuration deleted
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard CREST error response
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  securitySchemes:
    ssoToken:
      type: apiKey
      in: header
      name: iPlanetDirectoryPro
      description: AM SSO token obtained from authentication
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token