Veeva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Veeva Vault REST Authentication API

2 actions 2 updates phrasing extends openapi/veeva-authentication-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Veeva's API. It is a proposal applied on top of the contract, not a document Veeva publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/auth'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Veeva Vault REST Authentication API
  version: 1.0.0
extends: openapi/veeva-authentication-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/auth'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign in to Vault and get a session ID
      effect: write
      questions:
      - How do I get a session ID to call the Veeva Vault API?
      - Can I log in with a username and password and reuse the session for later calls?
      - Which vault do I end up in when my login has access to several vaults?
      instructions:
      - text: Log in to Vault as {username} with password {password} and return the session ID.
        slots:
          username: requestBody.username
          password: requestBody.password
      - text: Authenticate {username} against the vault at {vaultDNS} using password {password}.
        slots:
          username: requestBody.username
          vaultDNS: requestBody.vaultDNS
          password: requestBody.password
      method: generated
      generated: '2026-09-26'