ForgeRock Directory Services API — Users

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Directory Services API — Users
  description: 'ForgeRock Directory Services API — Users. 3 operations. Lead operation: List directory users. Self-contained
    Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FORGEROCK_API_KEY: FORGEROCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: directory-services-users
    baseUri: https://{deployment}/ds
    description: ForgeRock Directory Services API — Users business capability. Self-contained, no shared references.
    resources:
    - name: api-users
      path: /api/users
      operations:
      - name: listusers
        method: GET
        description: List directory users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Create a directory user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-users-userId
      path: /api/users/{userId}
      operations:
      - name: useraction
        method: POST
        description: Perform a user action
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _action
          in: query
          type: string
          description: The action to perform
          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: directory-services-users-rest
    port: 8080
    description: REST adapter for ForgeRock Directory Services API — Users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/users
      name: api-users
      description: REST surface for api-users.
      operations:
      - method: GET
        name: listusers
        description: List directory users
        call: directory-services-users.listusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Create a directory user
        call: directory-services-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/users/{userid}
      name: api-users-userid
      description: REST surface for api-users-userId.
      operations:
      - method: POST
        name: useraction
        description: Perform a user action
        call: directory-services-users.useraction
        with:
          _action: rest._action
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: directory-services-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Directory Services API — Users. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-directory-users
      description: List directory users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: directory-services-users.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: create-directory-user
      description: Create a directory user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: directory-services-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: perform-user-action
      description: Perform a user action
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: directory-services-users.useraction
      with:
        _action: tools._action
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.