ForgeRock System Objects API

openapi: 3.2.0
info:
  title: ForgeRock Identity Management System Objects API
  description: REST API for ForgeRock Identity Management (IDM) providing CRUD operations on managed objects and identity lifecycle management. Supports provisioning, synchronization, reconciliation, workflow-driven identity operations, and configuration management through the /openidm context path.
  version: 7.4.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: identity-management
servers:
- url: https://{deployment}/openidm
  description: ForgeRock Identity Management server
  variables:
    deployment:
      default: idm.example.com
      description: The IDM deployment hostname
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: System Objects
  description: Access objects in connected remote systems
paths:
  /system/{systemName}/{objectType}:
    get:
      operationId: listSystemObjects
      summary: ForgeRock List system objects
      description: Query objects from a connected remote system (connector). The system name and object type correspond to the connector configuration and its object types.
      tags:
      - System Objects
      parameters:
      - name: systemName
        in: path
        required: true
        description: Name of the connected system
        schema:
          type: string
      - name: objectType
        in: path
        required: true
        description: Object type in the connected system (e.g., account, group)
        schema:
          type: string
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: Query results from the remote system
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        '404':
          description: System or object type not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /system/{systemName}/{objectType}/{objectId}:
    get:
      operationId: getSystemObject
      summary: ForgeRock Get a system object
      description: Retrieve a specific object from a connected remote system.
      tags:
      - System Objects
      parameters:
      - name: systemName
        in: path
        required: true
        description: Name of the connected system
        schema:
          type: string
      - name: objectType
        in: path
        required: true
        description: Object type in the connected system
        schema:
          type: string
      - name: objectId
        in: path
        required: true
        description: Object identifier in the remote system
        schema:
          type: string
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: The system object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedObject'
        '404':
          description: Object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    PageSize:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression
      schema:
        type: string
    Fields:
      name: _fields
      in: query
      description: Comma-separated fields to include in the response
      schema:
        type: string
  schemas:
    ManagedObject:
      type: object
      description: A managed identity object
      properties:
        _id:
          type: string
          description: Unique identifier
          readOnly: true
        _rev:
          type: string
          description: Object revision for concurrency control
          readOnly: true
      additionalProperties: true
    QueryResult:
      type: object
      description: CREST query result
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/ManagedObject'
        resultCount:
          type: integer
        pagedResultsCookie:
          type: string
        totalPagedResultsPolicy:
          type: string
        totalPagedResults:
          type: integer
        remainingPagedResults:
          type: integer
    ErrorResponse:
      type: object
      description: Standard CREST error response
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token or IDM session token
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication (for internal admin access)