ForgeRock Access Management API — Resource Types

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Access Management API — Resource Types
  description: 'ForgeRock Access Management API — Resource Types. 5 operations. Lead operation: ForgeRock List resource types.
    Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Resource Types
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FORGEROCK_API_KEY: FORGEROCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: access-management-resource-types
    baseUri: https://{deployment}/am
    description: ForgeRock Access Management API — Resource Types business capability. Self-contained, no shared references.
    resources:
    - name: json-realms-root-realms-realm-resourcetypes
      path: /json/realms/root/realms/{realm}/resourcetypes
      operations:
      - name: listresourcetypes
        method: GET
        description: ForgeRock List resource types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _queryFilter
          in: query
          type: string
          description: CREST query filter
      - name: createresourcetype
        method: POST
        description: ForgeRock Create a resource type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: json-realms-root-realms-realm-resourcetypes-resourceTypeId
      path: /json/realms/root/realms/{realm}/resourcetypes/{resourceTypeId}
      operations:
      - name: getresourcetype
        method: GET
        description: ForgeRock Get a resource type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resourceTypeId
          in: path
          type: string
          description: The resource type UUID
          required: true
      - name: updateresourcetype
        method: PUT
        description: ForgeRock Update a resource type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resourceTypeId
          in: path
          type: string
          description: The resource type UUID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteresourcetype
        method: DELETE
        description: ForgeRock Delete a resource type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resourceTypeId
          in: path
          type: string
          description: The resource type UUID
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: access-management-resource-types-rest
    port: 8080
    description: REST adapter for ForgeRock Access Management API — Resource Types. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/json/realms/root/realms/{realm}/resourcetypes
      name: json-realms-root-realms-realm-resourcetypes
      description: REST surface for json-realms-root-realms-realm-resourcetypes.
      operations:
      - method: GET
        name: listresourcetypes
        description: ForgeRock List resource types
        call: access-management-resource-types.listresourcetypes
        with:
          _queryFilter: rest._queryFilter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createresourcetype
        description: ForgeRock Create a resource type
        call: access-management-resource-types.createresourcetype
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/realms/root/realms/{realm}/resourcetypes/{resourcetypeid}
      name: json-realms-root-realms-realm-resourcetypes-resourcetypeid
      description: REST surface for json-realms-root-realms-realm-resourcetypes-resourceTypeId.
      operations:
      - method: GET
        name: getresourcetype
        description: ForgeRock Get a resource type
        call: access-management-resource-types.getresourcetype
        with:
          resourceTypeId: rest.resourceTypeId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateresourcetype
        description: ForgeRock Update a resource type
        call: access-management-resource-types.updateresourcetype
        with:
          resourceTypeId: rest.resourceTypeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteresourcetype
        description: ForgeRock Delete a resource type
        call: access-management-resource-types.deleteresourcetype
        with:
          resourceTypeId: rest.resourceTypeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: access-management-resource-types-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Access Management API — Resource Types. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: forgerock-list-resource-types
      description: ForgeRock List resource types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: access-management-resource-types.listresourcetypes
      with:
        _queryFilter: tools._queryFilter
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-create-resource-type
      description: ForgeRock Create a resource type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: access-management-resource-types.createresourcetype
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-resource-type
      description: ForgeRock Get a resource type
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: access-management-resource-types.getresourcetype
      with:
        resourceTypeId: tools.resourceTypeId
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-update-resource-type
      description: ForgeRock Update a resource type
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: access-management-resource-types.updateresourcetype
      with:
        resourceTypeId: tools.resourceTypeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-delete-resource-type
      description: ForgeRock Delete a resource type
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: access-management-resource-types.deleteresourcetype
      with:
        resourceTypeId: tools.resourceTypeId
      outputParameters:
      - type: object
        mapping: $.