ForgeRock Entitlements API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Entitlements 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: Entitlements
  description: Query entitlements and confidence scores
paths:
  /api/entitlements:
    get:
      operationId: listEntitlements
      summary: ForgeRock List entitlements
      description: Query entitlements across all onboarded applications. Returns entitlement details with aggregated confidence score statistics.
      tags:
      - Entitlements
      parameters:
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      - name: application
        in: query
        description: Filter by application name
        schema:
          type: string
      - name: confidenceThreshold
        in: query
        description: Minimum confidence score threshold (0-100)
        schema:
          type: number
          minimum: 0
          maximum: 100
      responses:
        '200':
          description: List of entitlements with confidence data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/entitlements/{entitlementId}:
    get:
      operationId: getEntitlement
      summary: ForgeRock Get entitlement details
      description: Retrieve detailed information about a specific entitlement including confidence score distribution, assigned users, and driving attributes.
      tags:
      - Entitlements
      parameters:
      - name: entitlementId
        in: path
        required: true
        description: The entitlement identifier
        schema:
          type: string
      responses:
        '200':
          description: Entitlement details with analytics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementDetail'
        '404':
          description: Entitlement not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/entitlements/{entitlementId}/users:
    get:
      operationId: listEntitlementUsers
      summary: ForgeRock List users with entitlement
      description: List all users assigned to a specific entitlement with their individual confidence scores and driving attributes.
      tags:
      - Entitlements
      parameters:
      - name: entitlementId
        in: path
        required: true
        description: The entitlement identifier
        schema:
          type: string
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      - name: confidenceThreshold
        in: query
        description: Filter by minimum confidence score
        schema:
          type: number
      responses:
        '200':
          description: List of users with confidence scores
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementUserList'
  /api/entitlements/{entitlementId}/recommendations:
    get:
      operationId: getEntitlementRecommendations
      summary: ForgeRock Get entitlement recommendations
      description: Retrieve recommendations for users who do not have the entitlement but should, based on their attribute data and the AI model's predictions.
      tags:
      - Entitlements
      parameters:
      - name: entitlementId
        in: path
        required: true
        description: The entitlement identifier
        schema:
          type: string
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      - name: confidenceThreshold
        in: query
        description: Minimum confidence score for recommendations
        schema:
          type: number
      responses:
        '200':
          description: Recommendations for the entitlement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationList'
  /governance/entitlement:
    get:
      operationId: listEntitlements
      summary: ForgeRock List entitlements
      description: Query the entitlements catalog. Entitlements are aggregated from onboarded target applications into a centralized repository.
      tags:
      - Entitlements
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize_2'
      - $ref: '#/components/parameters/PagedResultsOffset'
      - $ref: '#/components/parameters/SortKeys'
      responses:
        '200':
          description: List of entitlements
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementList_2'
  /governance/entitlement/{entitlementId}:
    get:
      operationId: getEntitlement
      summary: ForgeRock Get an entitlement
      description: Retrieve details of a specific entitlement.
      tags:
      - Entitlements
      parameters:
      - name: entitlementId
        in: path
        required: true
        description: The entitlement identifier
        schema:
          type: string
      responses:
        '200':
          description: Entitlement details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entitlement'
        '404':
          description: Entitlement not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    EntitlementDetail:
      type: object
      description: Detailed entitlement with analytics data
      properties:
        id:
          type: string
        name:
          type: string
          description: Entitlement name
        description:
          type: string
        application:
          type: string
          description: Source application name
        totalUsers:
          type: integer
          description: Number of users with this entitlement
        averageConfidenceScore:
          type: number
          description: Average confidence score across all assignments
        confidenceDistribution:
          type: object
          description: Distribution of confidence scores
          properties:
            high:
              type: integer
              description: Assignments with confidence >= 80%
            medium:
              type: integer
              description: Assignments with confidence 50-79%
            low:
              type: integer
              description: Assignments with confidence < 50%
        drivingAttributes:
          type: array
          description: User attributes that most influence this entitlement assignment
          items:
            type: object
            properties:
              attribute:
                type: string
              weight:
                type: number
    Entitlement:
      type: object
      description: An entitlement from an onboarded application
      properties:
        _id:
          type: string
        name:
          type: string
          description: Entitlement name
        description:
          type: string
        applicationName:
          type: string
          description: Source application
        applicationId:
          type: string
        type:
          type: string
          description: Entitlement type (e.g., group, permission, role)
        owner:
          type: string
          description: Entitlement owner
        riskLevel:
          type: string
          enum:
          - low
          - medium
          - high
          - critical
    EntitlementList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/EntitlementDetail'
        totalResults:
          type: integer
        offset:
          type: integer
    RecommendationList:
      type: object
      description: Entitlement recommendations
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              userId:
                type: string
              userName:
                type: string
              entitlementId:
                type: string
              entitlementName:
                type: string
              application:
                type: string
              confidenceScore:
                type: number
                description: Predicted confidence score
              drivingAttributes:
                type: object
                additionalProperties:
                  type: string
        totalResults:
          type: integer
    EntitlementUserList:
      type: object
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              userId:
                type: string
              userName:
                type: string
              confidenceScore:
                type: number
                description: Confidence score (0-100)
              drivingAttributes:
                type: object
                description: Attributes driving the confidence score
                additionalProperties:
                  type: string
        totalResults:
          type: integer
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
    EntitlementList_2:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Entitlement'
        resultCount:
          type: integer
        totalPagedResults:
          type: integer
  parameters:
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression
      schema:
        type: string
    Offset:
      name: offset
      in: query
      description: Offset for pagination
      schema:
        type: integer
        minimum: 0
        default: 0
    SortKeys:
      name: _sortKeys
      in: query
      description: Sort fields
      schema:
        type: string
    PagedResultsOffset:
      name: _pagedResultsOffset
      in: query
      description: Pagination offset
      schema:
        type: integer
        minimum: 0
    PageSize:
      name: maxResults
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        minimum: 1
        default: 25
    PageSize_2:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
  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