ForgeRock

ForgeRock Managed Objects API

CRUD operations on managed identity objects

GitHub OpenAPI

Operations 6

GET /managed/{objectType} ForgeRock List managed objects #
POST /managed/{objectType} ForgeRock Create a managed object #
GET /managed/{objectType}/{objectId} ForgeRock Get a managed object #
PUT /managed/{objectType}/{objectId} ForgeRock Replace a managed object #
PATCH /managed/{objectType}/{objectId} ForgeRock Patch a managed object #
DELETE /managed/{objectType}/{objectId} ForgeRock Delete a managed object #

Documentation

📖
Documentation
https://backstage.forgerock.com/docs/idcloud/latest/
📖
APIReference
https://apidocs.id.forgerock.io/
📖
GettingStarted
https://backstage.forgerock.com/docs/idcloud/latest/home.html
📖
Authentication
https://backstage.forgerock.com/docs/idcloud/latest/developer-docs/authenticate-to-rest-api-overview.html
📖
Documentation
https://backstage.forgerock.com/docs/am/7.3/
📖
APIReference
https://backstage.forgerock.com/docs/am/7.3/apidocs/
📖
Authentication
https://backstage.forgerock.com/docs/am/7/authentication-guide/
📖
GettingStarted
https://backstage.forgerock.com/docs/am/7.1/REST-guide/basic-rest-authentication.html
📖
Documentation
https://backstage.forgerock.com/docs/idm/7.4/
📖
GettingStarted
https://backstage.forgerock.com/docs/idm/7.4/getting-started/
📖
Documentation
https://backstage.forgerock.com/docs/ig/7.3/
📖
GettingStarted
https://backstage.forgerock.com/docs/ig/7/gateway-guide/
📖
Documentation
https://backstage.forgerock.com/docs/ds/7.4/
📖
GettingStarted
https://backstage.forgerock.com/docs/ds/7.4/getting-started/rest.html
📖
Documentation
https://backstage.forgerock.com/docs/identity-governance/7.1/api-guide/preface.html
📖
APIReference
https://backstage.forgerock.com/docs/idcloud/latest/identity-governance/rest-api/endpoints/rest-iga.html
📖
Documentation
https://backstage.forgerock.com/docs/autonomous-identity/2022.11.0/api-guide/preface.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/forgerock/refs/heads/main/openapi/forgerock-managed-objects-api-openapi.yml

Other Resources

🔗
SDKs
https://backstage.forgerock.com/docs/idcloud/latest/end-user/sdks.html
🔗
ChangeLog
https://backstage.forgerock.com/docs/am/7/release-notes/
🔗
REST API Guide
https://backstage.forgerock.com/docs/idm/7.4/rest-api-reference/
🔗
ChangeLog
https://backstage.forgerock.com/docs/idm/7.4/release-notes/preface.html
🔗
Reference
https://backstage.forgerock.com/docs/ig/7.3/reference/
🔗
REST API
https://backstage.forgerock.com/docs/ds/7.4/rest-guide/
🔗
Reference
https://backstage.forgerock.com/docs/ds/7.4/rest-guide/rest-operations.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/forgerock-managed-objects-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

forgerock-managed-objects-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ForgeRock Identity Management Managed 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: Managed Objects
  description: CRUD operations on managed identity objects
paths:
  /managed/{objectType}:
    get:
      operationId: listManagedObjects
      summary: ForgeRock List managed objects
      description: Query managed objects of the specified type. Supports CREST query filters, pagination, sorting, and field selection.
      tags:
      - Managed Objects
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagedResultsOffset'
      - $ref: '#/components/parameters/SortKeys'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: Query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: createManagedObject
      summary: ForgeRock Create a managed object
      description: Create a new managed object of the specified type. The server assigns the _id if not provided via the _action=create query parameter.
      tags:
      - Managed Objects
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - name: _action
        in: query
        description: Must be set to create for server-assigned IDs
        schema:
          type: string
          enum:
          - create
      requestBody:
        required: true
        description: The managed object to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagedObject'
      responses:
        '201':
          description: Object created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedObject'
        '400':
          description: Invalid object data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Object already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /managed/{objectType}/{objectId}:
    get:
      operationId: getManagedObject
      summary: ForgeRock Get a managed object
      description: Retrieve a specific managed object by type and identifier.
      tags:
      - Managed Objects
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/ObjectId'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: The managed object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedObject'
        '404':
          description: Object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: updateManagedObject
      summary: ForgeRock Replace a managed object
      description: Replace an entire managed object or create one with a client-assigned identifier.
      tags:
      - Managed Objects
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/ObjectId'
      - name: If-Match
        in: header
        description: Revision for optimistic concurrency control
        schema:
          type: string
          default: '*'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagedObject'
      responses:
        '200':
          description: Object updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedObject'
        '201':
          description: Object created with client-assigned ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedObject'
        '412':
          description: Revision mismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: patchManagedObject
      summary: ForgeRock Patch a managed object
      description: Partially update a managed object using JSON Patch operations (add, remove, replace, increment).
      tags:
      - Managed Objects
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/ObjectId'
      - name: If-Match
        in: header
        description: Revision for optimistic concurrency control
        schema:
          type: string
          default: '*'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOperations'
      responses:
        '200':
          description: Object patched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedObject'
        '404':
          description: Object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteManagedObject
      summary: ForgeRock Delete a managed object
      description: Delete a managed object by type and identifier.
      tags:
      - Managed Objects
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/ObjectId'
      - name: If-Match
        in: header
        description: Revision for optimistic concurrency control
        schema:
          type: string
          default: '*'
      responses:
        '200':
          description: Object deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedObject'
        '404':
          description: Object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    SortKeys:
      name: _sortKeys
      in: query
      description: Comma-separated sort fields (prefix with - for descending)
      schema:
        type: string
    PageSize:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
    ObjectType:
      name: objectType
      in: path
      required: true
      description: The managed object type (e.g., user, role, assignment, organization). In Identity Cloud, this is prefixed with the realm name (e.g., alpha_user).
      schema:
        type: string
    PagedResultsOffset:
      name: _pagedResultsOffset
      in: query
      description: Offset for pagination
      schema:
        type: integer
        minimum: 0
    ObjectId:
      name: objectId
      in: path
      required: true
      description: The unique identifier of the managed object
      schema:
        type: string
    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:
    PatchOperations:
      type: array
      description: JSON Patch operations
      items:
        type: object
        required:
        - operation
        - field
        properties:
          operation:
            type: string
            enum:
            - add
            - remove
            - replace
            - increment
          field:
            type: string
          value: {}
    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)