HashiCorp Vault Vault Auth Methods API — AppRole

naftiko: 1.0.0-alpha2
info:
  label: HashiCorp Vault Vault Auth Methods API — AppRole
  description: 'HashiCorp Vault Vault Auth Methods API — AppRole. 6 operations. Lead operation: HashiCorp Vault Login with
    AppRole. Self-contained Naftiko capability covering one Hvault business surface.'
  tags:
  - Hvault
  - AppRole
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HVAULT_API_KEY: HVAULT_API_KEY
capability:
  consumes:
  - type: http
    namespace: auth-methods-approle
    baseUri: https://vault.example.com/v1
    description: HashiCorp Vault Vault Auth Methods API — AppRole business capability. Self-contained, no shared references.
    resources:
    - name: auth-approle-login
      path: /auth/approle/login
      operations:
      - name: loginwithapprole
        method: POST
        description: HashiCorp Vault Login with AppRole
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: auth-approle-role-role_name
      path: /auth/approle/role/{role_name}
      operations:
      - name: readapprole
        method: GET
        description: HashiCorp Vault Read AppRole
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorupdateapprole
        method: POST
        description: HashiCorp Vault Create or update AppRole
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapprole
        method: DELETE
        description: HashiCorp Vault Delete AppRole
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: auth-approle-role-role_name-role-id
      path: /auth/approle/role/{role_name}/role-id
      operations:
      - name: readapproleroleid
        method: GET
        description: HashiCorp Vault Read AppRole role ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: auth-approle-role-role_name-secret-id
      path: /auth/approle/role/{role_name}/secret-id
      operations:
      - name: generateapprolesecretid
        method: POST
        description: HashiCorp Vault Generate AppRole secret ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-Vault-Token
      value: '{{env.HVAULT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: auth-methods-approle-rest
    port: 8080
    description: REST adapter for HashiCorp Vault Vault Auth Methods API — AppRole. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/auth/approle/login
      name: auth-approle-login
      description: REST surface for auth-approle-login.
      operations:
      - method: POST
        name: loginwithapprole
        description: HashiCorp Vault Login with AppRole
        call: auth-methods-approle.loginwithapprole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/auth/approle/role/{role-name}
      name: auth-approle-role-role-name
      description: REST surface for auth-approle-role-role_name.
      operations:
      - method: GET
        name: readapprole
        description: HashiCorp Vault Read AppRole
        call: auth-methods-approle.readapprole
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorupdateapprole
        description: HashiCorp Vault Create or update AppRole
        call: auth-methods-approle.createorupdateapprole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapprole
        description: HashiCorp Vault Delete AppRole
        call: auth-methods-approle.deleteapprole
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/auth/approle/role/{role-name}/role-id
      name: auth-approle-role-role-name-role-id
      description: REST surface for auth-approle-role-role_name-role-id.
      operations:
      - method: GET
        name: readapproleroleid
        description: HashiCorp Vault Read AppRole role ID
        call: auth-methods-approle.readapproleroleid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/auth/approle/role/{role-name}/secret-id
      name: auth-approle-role-role-name-secret-id
      description: REST surface for auth-approle-role-role_name-secret-id.
      operations:
      - method: POST
        name: generateapprolesecretid
        description: HashiCorp Vault Generate AppRole secret ID
        call: auth-methods-approle.generateapprolesecretid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: auth-methods-approle-mcp
    port: 9090
    transport: http
    description: MCP adapter for HashiCorp Vault Vault Auth Methods API — AppRole. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: hashicorp-vault-login-approle
      description: HashiCorp Vault Login with AppRole
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: auth-methods-approle.loginwithapprole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-read-approle
      description: HashiCorp Vault Read AppRole
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: auth-methods-approle.readapprole
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-create-update-approle
      description: HashiCorp Vault Create or update AppRole
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: auth-methods-approle.createorupdateapprole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-delete-approle
      description: HashiCorp Vault Delete AppRole
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: auth-methods-approle.deleteapprole
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-read-approle-role
      description: HashiCorp Vault Read AppRole role ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: auth-methods-approle.readapproleroleid
      outputParameters:
      - type: object
        mapping: $.
    - name: hashicorp-vault-generate-approle-secret
      description: HashiCorp Vault Generate AppRole secret ID
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: auth-methods-approle.generateapprolesecretid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.