ForgeRock Violations API

openapi: 3.2.0
info:
  title: ForgeRock Identity Governance Violations API
  description: REST API for ForgeRock Identity Governance providing access reviews, certifications, role management, entitlement management, access requests, and compliance workflows. Enables organizations to review and certify access assignments, manage entitlements from onboarded applications, and enforce compliance policies.
  version: 7.1.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: identity-governance
servers:
- url: https://{deployment}/iga
  description: ForgeRock Identity Governance server
  variables:
    deployment:
      default: iga.example.com
      description: The Identity Governance deployment hostname
security:
- bearerAuth: []
tags:
- name: Violations
  description: Manage policy violations and segregation of duties
paths:
  /governance/violation:
    get:
      operationId: listViolations
      summary: ForgeRock List policy violations
      description: Query segregation of duties (SoD) and compliance policy violations.
      tags:
      - Violations
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagedResultsOffset'
      responses:
        '200':
          description: List of violations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViolationList'
  /governance/violation/{violationId}:
    get:
      operationId: getViolation
      summary: ForgeRock Get a policy violation
      description: Retrieve details of a specific policy violation.
      tags:
      - Violations
      parameters:
      - name: violationId
        in: path
        required: true
        description: The violation identifier
        schema:
          type: string
      responses:
        '200':
          description: Violation details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Violation'
        '404':
          description: Violation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: violationAction
      summary: ForgeRock Resolve a policy violation
      description: Perform an action on a violation such as remediate, allow (exception), or escalate.
      tags:
      - Violations
      parameters:
      - name: violationId
        in: path
        required: true
        description: The violation identifier
        schema:
          type: string
      - name: _action
        in: query
        required: true
        description: The action to perform
        schema:
          type: string
          enum:
          - remediate
          - allow
          - escalate
      requestBody:
        description: Action details
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
                exceptionDuration:
                  type: string
      responses:
        '200':
          description: Violation action completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Violation'
components:
  parameters:
    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
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression
      schema:
        type: string
  schemas:
    ViolationList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Violation'
        resultCount:
          type: integer
        totalPagedResults:
          type: integer
    Violation:
      type: object
      description: A segregation of duties or compliance policy violation
      properties:
        _id:
          type: string
        policyName:
          type: string
          description: Name of the violated policy
        userId:
          type: string
          description: User in violation
        userName:
          type: string
        conflictingEntitlements:
          type: array
          description: Entitlements that conflict
          items:
            type: string
        status:
          type: string
          enum:
          - active
          - remediated
          - exception
        severity:
          type: string
          enum:
          - low
          - medium
          - high
          - critical
        detectedDate:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token with governance scopes