Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Console Getting Started Authenticating to the API

2 actions 2 updates phrasing extends openapi/strivacity-authenticating-to-the-api-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/oauth2/token'].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 Admin Console Getting Started Authenticating to the API
  version: 1.0.0
extends: openapi/strivacity-authenticating-to-the-api-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/oauth2/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an access token for the API
      effect: write
      questions:
      - How do I authenticate to the Strivacity admin API?
      - Which grant type and audience do I send to get an access token?
      instructions:
      - text: Get an access token with grant type {grant_type} for audience {audience} and scope {scope}.
        slots:
          grant_type: requestBody.grant_type
          audience: requestBody.audience
          scope: requestBody.scope
      - text: Exchange my client credentials for a token scoped to {scope} on {audience} using {grant_type}.
        slots:
          scope: requestBody.scope
          audience: requestBody.audience
          grant_type: requestBody.grant_type
      method: generated
      generated: '2026-10-01'