ForgeRock Synchronization API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Synchronization 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: Synchronization
  description: Trigger on-demand synchronization
paths:
  /sync:
    post:
      operationId: triggerSync
      summary: ForgeRock Trigger on-demand synchronization
      description: Trigger a synchronization action for a specific object change. Useful for performing immediate sync of individual objects.
      tags:
      - Synchronization
      parameters:
      - name: _action
        in: query
        required: true
        description: Must be performAction
        schema:
          type: string
          enum:
          - performAction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  description: The sync action to perform
                  enum:
                  - CREATE
                  - UPDATE
                  - DELETE
                  - LINK
                  - UNLINK
                mapping:
                  type: string
                  description: The mapping name
                sourceId:
                  type: string
                  description: The source object identifier
      responses:
        '200':
          description: Sync action performed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  action:
                    type: string
components:
  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