openapi: 3.1.0
info:
  title: HashiCorp Vault Vault Auth Methods AppRole Configuration API
  description: APIs for authentication methods in HashiCorp Vault including Token, AppRole, Kubernetes, LDAP, JWT/OIDC, GitHub, Userpass, and AWS auth methods. These endpoints handle user and machine authentication to obtain Vault tokens.
  version: '1.0'
  contact:
    name: HashiCorp Support
    email: support@hashicorp.com
    url: https://support.hashicorp.com/
  license:
    name: Business Source License 1.1
    url: https://github.com/hashicorp/vault/blob/main/LICENSE
servers:
- url: https://vault.example.com/v1
  description: Vault Server
security:
- vaultToken: []
tags:
- name: Configuration
  description: General Vault configuration
paths:
  /sys/config/auditing/request-headers:
    get:
      operationId: listAuditRequestHeaders
      summary: HashiCorp Vault List audited request headers
      description: Lists the request headers configured for auditing.
      tags:
      - Configuration
      responses:
        '200':
          description: Audited headers listed
          content:
            application/json:
              schema:
                type: object
                properties:
                  headers:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        hmac:
                          type: boolean
        '403':
          description: Permission denied
  /sys/generate-root/attempt:
    get:
      operationId: readRootGenerationProgress
      summary: HashiCorp Vault Read root generation progress
      description: Reads the status of the current root generation attempt.
      tags:
      - Configuration
      responses:
        '200':
          description: Root generation progress returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  started:
                    type: boolean
                  nonce:
                    type: string
                  progress:
                    type: integer
                  required:
                    type: integer
                  complete:
                    type: boolean
                  encoded_token:
                    type: string
                  encoded_root_token:
                    type: string
                  pgp_fingerprint:
                    type: string
      security: []
    put:
      operationId: startRootGeneration
      summary: HashiCorp Vault Start root token generation
      description: Initializes a new root generation attempt.
      tags:
      - Configuration
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                pgp_key:
                  type: string
                  description: PGP key to encrypt the generated root token
      responses:
        '200':
          description: Root generation started
          content:
            application/json:
              schema:
                type: object
                properties:
                  started:
                    type: boolean
                  nonce:
                    type: string
                  progress:
                    type: integer
                  required:
                    type: integer
                  complete:
                    type: boolean
                  pgp_fingerprint:
                    type: string
      security: []
    delete:
      operationId: cancelRootGeneration
      summary: HashiCorp Vault Cancel root token generation
      description: Cancels the current root generation attempt.
      tags:
      - Configuration
      responses:
        '204':
          description: Root generation cancelled
      security: []
components:
  securitySchemes:
    vaultToken:
      type: apiKey
      in: header
      name: X-Vault-Token
      description: Vault authentication token
externalDocs:
  description: Vault Auth Methods API Documentation
  url: https://developer.hashicorp.com/vault/api-docs/auth