ForgeRock Applications API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Applications 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: Applications
  description: Query onboarded application data
paths:
  /api/applications:
    get:
      operationId: listApplications
      summary: ForgeRock List applications
      description: Query onboarded applications in the Autonomous Identity platform.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of applications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationList'
  /api/applications/{applicationId}:
    get:
      operationId: getApplication
      summary: ForgeRock Get an application
      description: Retrieve details of a specific onboarded application.
      tags:
      - Applications
      parameters:
      - name: applicationId
        in: path
        required: true
        description: The application identifier
        schema:
          type: string
      responses:
        '200':
          description: Application details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '404':
          description: Application not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    Offset:
      name: offset
      in: query
      description: Offset for pagination
      schema:
        type: integer
        minimum: 0
        default: 0
    PageSize:
      name: maxResults
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        minimum: 1
        default: 25
  schemas:
    ApplicationList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Application'
        totalResults:
          type: integer
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
    Application:
      type: object
      description: An onboarded application
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        totalEntitlements:
          type: integer
        totalUsers:
          type: integer
        averageConfidenceScore:
          type: number
  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