ForgeRock Roles API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Roles 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: Roles
  description: Manage identity governance roles
paths:
  /governance/role:
    get:
      operationId: listGovernanceRoles
      summary: ForgeRock List governance roles
      description: Query governance roles used in access policies and certifications.
      tags:
      - Roles
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagedResultsOffset'
      responses:
        '200':
          description: List of governance roles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GovernanceRoleList'
components:
  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
  schemas:
    GovernanceRole:
      type: object
      description: A governance role
      properties:
        _id:
          type: string
        name:
          type: string
        description:
          type: string
        owner:
          type: string
        members:
          type: array
          items:
            type: string
        entitlements:
          type: array
          items:
            type: string
    GovernanceRoleList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/GovernanceRole'
        resultCount:
          type: integer
  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