ForgeRock

ForgeRock Rules API

Access entitlement assignment rules and justifications

Documentation GitHub OpenAPI

Operations 2

GET /api/rules ForgeRock List assignment rules #

GET /api/rules/{ruleId} ForgeRock Get a rule #

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-rules-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

openapi: 3.2.0
info:
  title: ForgeRock Autonomous Identity Rules API
  description: REST API for the ForgeRock Autonomous Identity analytics platform. Uses AI-driven analysis powered by Apache Spark to determine confidence scores, predictions, and recommendations for entitlement assignments. Provides endpoints for accessing entitlements, rules, applications, company views, and analytics data.
  version: 2022.11.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: autonomous-identity
servers:
- url: https://{deployment}/autoid
  description: ForgeRock Autonomous Identity server
  variables:
    deployment:
      default: autoid.example.com
      description: The Autonomous Identity deployment hostname
security:
- bearerAuth: []
tags:
- name: Rules
  description: Access entitlement assignment rules and justifications
paths:
  /api/rules:
    get:
      operationId: listRules
      summary: ForgeRock List assignment rules
      description: Query entitlement assignment rules derived from the AI model. Rules explain why specific entitlements are assigned based on user attribute combinations.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      - name: entitlement
        in: query
        description: Filter by entitlement name
        schema:
          type: string
      - name: application
        in: query
        description: Filter by application name
        schema:
          type: string
      responses:
        '200':
          description: List of rules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleList'
  /api/rules/{ruleId}:
    get:
      operationId: getRule
      summary: ForgeRock Get a rule
      description: Retrieve details of a specific assignment rule.
      tags:
      - Rules
      parameters:
      - name: ruleId
        in: path
        required: true
        description: The rule identifier
        schema:
          type: string
      responses:
        '200':
          description: Rule details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
        '404':
          description: Rule not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Rule:
      type: object
      description: An entitlement assignment rule from the AI model
      properties:
        id:
          type: string
        entitlement:
          type: string
          description: Entitlement this rule applies to
        application:
          type: string
        conditions:
          type: array
          description: Attribute conditions that define this rule
          items:
            type: object
            properties:
              attribute:
                type: string
              operator:
                type: string
                enum:
                - equals
                - contains
                - startsWith
              value:
                type: string
        confidenceScore:
          type: number
          description: Confidence score for assignments matching this rule
        coverageCount:
          type: integer
          description: Number of users matching this rule
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
    RuleList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
        totalResults:
          type: integer
  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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Authentication token for Autonomous Identity API