HashiCorp Vault Vault Identity API — Entity

naftiko: 1.0.0-alpha2
info:
  label: HashiCorp Vault Vault Identity API — Entity
  description: 'HashiCorp Vault Vault Identity API — Entity. 10 operations. Lead operation: HashiCorp Vault Create entity.
    Self-contained Naftiko capability covering one Hvault business surface.'
  tags:
  - Hvault
  - Entity
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HVAULT_API_KEY: HVAULT_API_KEY
capability:
  consumes:
  - type: http
    namespace: identity-entity
    baseUri: https://vault.example.com/v1
    description: HashiCorp Vault Vault Identity API — Entity business capability. Self-contained, no shared references.
    resources:
    - name: identity-entity
      path: /identity/entity
      operations:
      - name: createentity
        method: POST
        description: HashiCorp Vault Create entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listentities
        method: GET
        description: HashiCorp Vault List entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: identity-entity-batch-delete
      path: /identity/entity/batch-delete
      operations:
      - name: batchdeleteentities
        method: POST
        description: HashiCorp Vault Batch delete entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: identity-entity-id-id
      path: /identity/entity/id/{id}
      operations:
      - name: readentitybyid
        method: GET
        description: HashiCorp Vault Read entity by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateentitybyid
        method: POST
        description: HashiCorp Vault Update entity by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteentitybyid
        method: DELETE
        description: HashiCorp Vault Delete entity by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: identity-entity-merge
      path: /identity/entity/merge
      operations:
      - name: mergeentities
        method: POST
        description: HashiCorp Vault Merge entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: identity-entity-name-name
      path: /identity/entity/name/{name}
      operations:
      - name: readentitybyname
        method: GET
        description: HashiCorp Vault Read entity by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of the entity
          required: true
      - name: updateentitybyname
        method: POST
        description: HashiCorp Vault Update entity by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of the entity
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteentitybyname
        method: DELETE
        description: HashiCorp Vault Delete entity by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of the entity
          required: true
    authentication:
      type: apikey
      key: X-Vault-Token
      value: '{{env.HVAULT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: identity-entity-rest
    port: 8080
    description: REST adapter for HashiCorp Vault Vault Identity API — Entity. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/identity/entity
      name: identity-entity
      description: REST surface for identity-entity.
      operations:
      - method: POST
        name: createentity
        description: HashiCorp Vault Create entity
        call: identity-entity.createentity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listentities
        description: HashiCorp Vault List entities
        call: identity-entity.listentities
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/identity/entity/batch-delete
      name: identity-entity-batch-delete
      description: REST surface for identity-entity-batch-delete.
      operations:
      - method: POST
        name: batchdeleteentities
        description: HashiCorp Vault Batch delete entities
        call: identity-entity.batchdeleteentities
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/identity/entity/id/{id}
      name: identity-entity-id-id
      description: REST surface for identity-entity-id-id.
      operations:
      - method: GET
        name: readentitybyid
        description: HashiCorp Vault Read entity by ID
        call: identity-entity.readentitybyid
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updateentitybyid
        description: HashiCorp Vault Update entity by ID
        call: identity-entity.updateentitybyid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteentitybyid
        description: HashiCorp Vault Delete entity by ID
        call: identity-entity.deleteentitybyid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/identity/entity/merge
      name: identity-entity-merge
      description: REST surface for identity-entity-merge.
      operations:
      - method: POST
        name: mergeentities
        description: HashiCorp Vault Merge entities
        call: identity-entity.mergeentities
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/identity/entity/name/{name}
      name: identity-entity-name-name
      description: REST surface for identity-entity-name-name.
      operations:
      - method: GET
        name: readentitybyname
        description: HashiCorp Vault Read entity by name
        call: identity-entity.readentitybyname
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updateentitybyname
        description: HashiCorp Vault Update entity by name
        call: identity-entity.updateentitybyname
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteentitybyname
        description: HashiCorp Vault Delete entity by name
        call: identity-entity.deleteentitybyname
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-entity-mcp
    port: 9090
    transport: http
    description: MCP adapter for HashiCorp Vault Vault Identity API — Entity. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: hashicorp-vault-create-entity
      description: HashiCorp Vault Create entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-entity.createentity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-list-entities
      description: HashiCorp Vault List entities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-entity.listentities
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-batch-delete-entities
      description: HashiCorp Vault Batch delete entities
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-entity.batchdeleteentities
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-read-entity-id
      description: HashiCorp Vault Read entity by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-entity.readentitybyid
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-update-entity-id
      description: HashiCorp Vault Update entity by ID
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-entity.updateentitybyid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-delete-entity-id
      description: HashiCorp Vault Delete entity by ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: identity-entity.deleteentitybyid
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-merge-entities
      description: HashiCorp Vault Merge entities
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-entity.mergeentities
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-read-entity-name
      description: HashiCorp Vault Read entity by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-entity.readentitybyname
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-update-entity-name
      description: HashiCorp Vault Update entity by name
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-entity.updateentitybyname
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-delete-entity-name
      description: HashiCorp Vault Delete entity by name
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: identity-entity.deleteentitybyname
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.