ForgeRock Access Requests API

openapi: 3.2.0
info:
  title: ForgeRock Identity Governance Access Requests 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: Access Requests
  description: Request and approve access to resources
paths:
  /governance/request:
    get:
      operationId: listAccessRequests
      summary: ForgeRock List access requests
      description: Query access requests. Users can request access to applications, entitlements, or roles, and managers can request revocation.
      tags:
      - Access Requests
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagedResultsOffset'
      - $ref: '#/components/parameters/SortKeys'
      responses:
        '200':
          description: List of access requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRequestList'
    post:
      operationId: createAccessRequest
      summary: ForgeRock Create an access request
      description: Submit a new access request for a user to gain access to a resource (application, entitlement, or role).
      tags:
      - Access Requests
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessRequest'
      responses:
        '201':
          description: Access request created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRequest'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /governance/request/{requestId}:
    get:
      operationId: getAccessRequest
      summary: ForgeRock Get an access request
      description: Retrieve details of a specific access request.
      tags:
      - Access Requests
      parameters:
      - name: requestId
        in: path
        required: true
        description: The access request identifier
        schema:
          type: string
      responses:
        '200':
          description: Access request details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRequest'
        '404':
          description: Request not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: accessRequestAction
      summary: ForgeRock Perform an access request action
      description: Approve, deny, or cancel an access request via the _action query parameter.
      tags:
      - Access Requests
      parameters:
      - name: requestId
        in: path
        required: true
        description: The access request identifier
        schema:
          type: string
      - name: _action
        in: query
        required: true
        description: The action to perform
        schema:
          type: string
          enum:
          - approve
          - deny
          - cancel
      requestBody:
        description: Action details
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  description: Approval or denial comment
      responses:
        '200':
          description: Action completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRequest'
components:
  schemas:
    AccessRequestList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/AccessRequest'
        resultCount:
          type: integer
        totalPagedResults:
          type: integer
    AccessRequest:
      type: object
      description: An access request
      properties:
        _id:
          type: string
          readOnly: true
        requestType:
          type: string
          description: Type of request
          enum:
          - grant
          - revoke
        userId:
          type: string
          description: User requesting or being requested for
        resourceType:
          type: string
          description: Type of resource requested
          enum:
          - application
          - entitlement
          - role
        resourceId:
          type: string
          description: Identifier of the requested resource
        justification:
          type: string
          description: Business justification
        status:
          type: string
          description: Request status
          enum:
          - pending
          - approved
          - denied
          - cancelled
          - fulfilled
          - failed
        approver:
          type: string
        createdDate:
          type: string
          format: date-time
          readOnly: true
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  parameters:
    SortKeys:
      name: _sortKeys
      in: query
      description: Sort fields
      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
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token with governance scopes