ForgeRock Analytics API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Analytics 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: Analytics
  description: Analytics pipeline status and results
paths:
  /api/analytics/status:
    get:
      operationId: getAnalyticsStatus
      summary: ForgeRock Get analytics pipeline status
      description: Retrieve the current status of the analytics pipeline, including training status, last run time, and pipeline health.
      tags:
      - Analytics
      responses:
        '200':
          description: Analytics pipeline status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsStatus'
  /api/analytics/reports:
    get:
      operationId: listAnalyticsReports
      summary: ForgeRock List analytics reports
      description: List available analytics reports from completed pipeline runs.
      tags:
      - Analytics
      parameters:
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of analytics reports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsReportList'
components:
  parameters:
    PageSize:
      name: maxResults
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        minimum: 1
        default: 25
    Offset:
      name: offset
      in: query
      description: Offset for pagination
      schema:
        type: integer
        minimum: 0
        default: 0
  schemas:
    AnalyticsStatus:
      type: object
      description: Analytics pipeline status
      properties:
        pipelineStatus:
          type: string
          enum:
          - idle
          - running
          - completed
          - failed
        lastRunTime:
          type: string
          format: date-time
        lastRunDuration:
          type: string
          description: Duration of the last pipeline run
        trainingStatus:
          type: string
          enum:
          - not_started
          - training
          - completed
          - failed
        predictionStatus:
          type: string
          enum:
          - not_started
          - running
          - completed
          - failed
        recommendationStatus:
          type: string
          enum:
          - not_started
          - running
          - completed
          - failed
    AnalyticsReportList:
      type: object
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              runDate:
                type: string
                format: date-time
              status:
                type: string
              totalEntitlementsProcessed:
                type: integer
              totalUsersProcessed:
                type: integer
              averageConfidenceScore:
                type: number
        totalResults:
          type: integer
  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