HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 Support Access API

4 actions 4 updates phrasing extends openapi/here-support-access-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/support'].get

$.paths['/support'].post

$.paths['/support'].delete

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 Authentication API v1.1 Support Access API
  version: 1.0.0
extends: openapi/here-support-access-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: 3
- target: $.paths['/support'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the realm's support access entry
      effect: read
      questions:
      - Is Account Executive support access enabled for my realm?
      - Which authorized users can currently log in to support my realm?
      instructions:
      - text: Show my realm's support access entry.
      - text: Check whether Account Executive support logins are enabled.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/support'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant support access to users
      effect: write
      questions:
      - How do I let a HERE account executive log in to my realm for support?
      - Can I set an expiry on support access I grant?
      instructions:
      - text: Register support access for {emailAddress}.
        slots:
          emailAddress: requestBody.emailAddress
      - text: Grant support login to {emailAddress} until {expiresAt}.
        slots:
          emailAddress: requestBody.emailAddress
          expiresAt: requestBody.expiresAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/support'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke support access to the realm
      effect: destructive
      questions:
      - How do I remove support access and log out any support users?
      - Can I revoke support access for just one email address?
      instructions:
      - text: Delete the support access entry for my realm.
      - text: Revoke support access for {emailAddress}.
        slots:
          emailAddress: query.emailAddress
      method: generated
      generated: '2026-09-26'