ForgeRock Access Reviews API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Access Reviews 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: Access Reviews
  description: Conduct and manage access review items
paths:
  /governance/certification/{certificationId}/items:
    get:
      operationId: listCertificationItems
      summary: ForgeRock List certification items
      description: List individual review items within a certification campaign. Each item represents a user-entitlement assignment to be reviewed.
      tags:
      - Access Reviews
      parameters:
      - $ref: '#/components/parameters/CertificationId'
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagedResultsOffset'
      responses:
        '200':
          description: List of certification review items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificationItemList'
  /governance/certification/{certificationId}/items/{itemId}:
    get:
      operationId: getCertificationItem
      summary: ForgeRock Get a certification item
      description: Retrieve details of a specific certification review item.
      tags:
      - Access Reviews
      parameters:
      - $ref: '#/components/parameters/CertificationId'
      - name: itemId
        in: path
        required: true
        description: The certification item identifier
        schema:
          type: string
      responses:
        '200':
          description: Certification item details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificationItem'
        '404':
          description: Item not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: reviewCertificationItem
      summary: ForgeRock Review a certification item
      description: Submit a review decision for a certification item. Decisions include certify (approve), revoke, or exception.
      tags:
      - Access Reviews
      parameters:
      - $ref: '#/components/parameters/CertificationId'
      - name: itemId
        in: path
        required: true
        description: The certification item identifier
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                decision:
                  type: string
                  description: Review decision
                  enum:
                  - certify
                  - revoke
                  - exception
                  - abstain
                comment:
                  type: string
                  description: Reviewer comment
                exceptionDuration:
                  type: string
                  description: Duration for exception (ISO 8601 period)
      responses:
        '200':
          description: Review submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificationItem'
components:
  schemas:
    CertificationItem:
      type: object
      description: An individual item within a certification campaign
      properties:
        _id:
          type: string
        userId:
          type: string
          description: User being reviewed
        userName:
          type: string
        entitlementName:
          type: string
          description: Entitlement under review
        applicationName:
          type: string
          description: Application the entitlement belongs to
        decision:
          type: string
          description: Current review decision
          enum:
          - certify
          - revoke
          - exception
          - abstain
          - pending
        comment:
          type: string
        reviewer:
          type: string
          description: Assigned reviewer
        reviewDate:
          type: string
          format: date-time
    CertificationItemList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/CertificationItem'
        resultCount:
          type: integer
        totalPagedResults:
          type: integer
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  parameters:
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression
      schema:
        type: string
    PageSize:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
    PagedResultsOffset:
      name: _pagedResultsOffset
      in: query
      description: Pagination offset
      schema:
        type: integer
        minimum: 0
    CertificationId:
      name: certificationId
      in: path
      required: true
      description: The certification campaign identifier
      schema:
        type: string
  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