ForgeRock Identity Cloud REST API — Authentication

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Cloud REST API — Authentication
  description: 'ForgeRock Identity Cloud REST API — Authentication. 1 operations. Lead operation: ForgeRock Authenticate a
    user. Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Authentication
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FORGEROCK_API_KEY: FORGEROCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: identity-cloud-authentication
    baseUri: https://{tenant}.forgeblocks.com
    description: ForgeRock Identity Cloud REST API — Authentication business capability. Self-contained, no shared references.
    resources:
    - name: am-json-realms-root-realms-realm-authenticate
      path: /am/json/realms/root/realms/{realm}/authenticate
      operations:
      - name: authenticateuser
        method: POST
        description: ForgeRock Authenticate a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: authIndexType
          in: query
          type: string
          description: The type of authentication index to use (e.g., service, module)
        - name: authIndexValue
          in: query
          type: string
          description: The value of the authentication index (e.g., the tree/journey name)
        - name: Accept-API-Version
          in: header
          type: string
          description: API version protocol header
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-cloud-authentication-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Cloud REST API — Authentication. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/am/json/realms/root/realms/{realm}/authenticate
      name: am-json-realms-root-realms-realm-authenticate
      description: REST surface for am-json-realms-root-realms-realm-authenticate.
      operations:
      - method: POST
        name: authenticateuser
        description: ForgeRock Authenticate a user
        call: identity-cloud-authentication.authenticateuser
        with:
          authIndexType: rest.authIndexType
          authIndexValue: rest.authIndexValue
          Accept-API-Version: rest.Accept-API-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-cloud-authentication-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Cloud REST API — Authentication. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: forgerock-authenticate-user
      description: ForgeRock Authenticate a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-cloud-authentication.authenticateuser
      with:
        authIndexType: tools.authIndexType
        authIndexValue: tools.authIndexValue
        Accept-API-Version: tools.Accept-API-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.