ForgeRock Company View API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Company View 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: Company View
  description: Company-wide analytics and dashboards
paths:
  /api/companyview:
    get:
      operationId: getCompanyView
      summary: ForgeRock Get company view analytics
      description: Retrieve company-wide analytics including confidence score distributions, entitlement statistics, and risk metrics across the entire organization.
      tags:
      - Company View
      responses:
        '200':
          description: Company-wide analytics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyView'
components:
  schemas:
    CompanyView:
      type: object
      description: Company-wide analytics summary
      properties:
        totalUsers:
          type: integer
        totalEntitlements:
          type: integer
        totalApplications:
          type: integer
        averageConfidenceScore:
          type: number
        confidenceDistribution:
          type: object
          properties:
            high:
              type: integer
            medium:
              type: integer
            low:
              type: integer
        riskSummary:
          type: object
          properties:
            highRiskUsers:
              type: integer
              description: Users with many low-confidence assignments
            highRiskEntitlements:
              type: integer
              description: Entitlements with low average confidence
            outlierAssignments:
              type: integer
              description: Assignments that differ from peer groups
  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