ForgeRock Identity Governance API — Entitlements

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Governance API — Entitlements
  description: 'ForgeRock Identity Governance API — Entitlements. 2 operations. Lead operation: ForgeRock List entitlements.
    Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Entitlements
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FORGEROCK_API_KEY: FORGEROCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: identity-governance-entitlements
    baseUri: https://{deployment}/iga
    description: ForgeRock Identity Governance API — Entitlements business capability. Self-contained, no shared references.
    resources:
    - name: governance-entitlement
      path: /governance/entitlement
      operations:
      - name: listentitlements
        method: GET
        description: ForgeRock List entitlements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: governance-entitlement-entitlementId
      path: /governance/entitlement/{entitlementId}
      operations:
      - name: getentitlement
        method: GET
        description: ForgeRock Get an entitlement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entitlementId
          in: path
          type: string
          description: The entitlement identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-governance-entitlements-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Governance API — Entitlements. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/governance/entitlement
      name: governance-entitlement
      description: REST surface for governance-entitlement.
      operations:
      - method: GET
        name: listentitlements
        description: ForgeRock List entitlements
        call: identity-governance-entitlements.listentitlements
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/governance/entitlement/{entitlementid}
      name: governance-entitlement-entitlementid
      description: REST surface for governance-entitlement-entitlementId.
      operations:
      - method: GET
        name: getentitlement
        description: ForgeRock Get an entitlement
        call: identity-governance-entitlements.getentitlement
        with:
          entitlementId: rest.entitlementId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-governance-entitlements-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Governance API — Entitlements. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: forgerock-list-entitlements
      description: ForgeRock List entitlements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-governance-entitlements.listentitlements
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-entitlement
      description: ForgeRock Get an entitlement
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-governance-entitlements.getentitlement
      with:
        entitlementId: tools.entitlementId
      outputParameters:
      - type: object
        mapping: $.