Penneo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Penneo Authentication OAuth API

4 actions 4 updates phrasing extends openapi/penneo-oauth-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Penneo's API. It is a proposal applied on top of the contract, not a document Penneo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/oauth/authorize'].get
$.paths['/oauth/revoke'].post
$.paths['/oauth/token'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Penneo Authentication OAuth API
  version: 1.0.0
extends: openapi/penneo-oauth-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/oauth/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Start OAuth login for a user
      effect: read
      questions:
      - How does a user sign in to my app with their Penneo account?
      - Where does the browser go after the user logs in?
      instructions:
      - text: Start OAuth login for {client_id} redirecting to {redirect_uri}.
        slots:
          client_id: query.client_id
          redirect_uri: query.redirect_uri
      - text: Send the user to the login page with PKCE challenge {code_challenge}.
        slots:
          code_challenge: query.code_challenge
      method: generated
      generated: '2026-11-20'
- target: $.paths['/oauth/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a refresh token
      effect: destructive
      questions:
      - How do I invalidate a refresh token?
      - Can I revoke a refresh token issued to another client?
      instructions:
      - text: Revoke refresh token {token} for {client_id}.
        slots:
          token: requestBody.token
          client_id: requestBody.client_id
      - text: Invalidate the refresh token {token}.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-11-20'
- target: $.paths['/oauth/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get or refresh an access token
      effect: write
      questions:
      - How do I turn an authorization code into an access token?
      - Can I refresh an access token with a refresh token?
      - Is there an API key grant for server-to-server access?
      instructions:
      - text: Exchange authorization code {code} for an access token.
        slots:
          code: requestBody.code
      - text: Refresh the access token using {refresh_token}.
        slots:
          refresh_token: requestBody.refresh_token
      - text: Get an access token with API key {key} and digest {digest}.
        slots:
          key: requestBody.key
          digest: requestBody.digest
      method: generated
      generated: '2026-11-20'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/penneo-oauth-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.