ForgeRock Violations API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Violations 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: 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:
  schemas:
    ViolationList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Violation'
        resultCount:
          type: integer
        totalPagedResults:
          type: integer
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
    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
  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
  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