Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Users User Passwords API

4 actions 4 updates phrasing extends openapi/zendesk-user-passwords-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/v2/users/{user_id}/password'].put

$.paths['/api/v2/users/{user_id}/password'].post

$.paths['/api/v2/users/{user_id}/password/requirements'].get

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 Zendesk Users User Passwords API
  version: 1.0.0
extends: openapi/zendesk-user-passwords-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['/api/v2/users/{user_id}/password'].put
  update:
    x-apievangelist-phrasing:
      intent: Change your own password
      effect: write
      questions:
      - Can I change my password if I know the current one?
      - Why can't anyone change another user's password with this call?
      instructions:
      - text: Change my password to a new one.
      - text: Update my own login password.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/password'].post
  update:
    x-apievangelist-phrasing:
      intent: Set another user's password as admin
      effect: write
      questions:
      - Can an admin set a new password for another user?
      - Which security setting must be on for admins to set passwords?
      instructions:
      - text: Set a new password for this user.
      - text: Reset the agent's password as an admin.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/password/requirements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get password requirements
      effect: read
      questions:
      - What rules must a new password meet?
      - Can end users see the password policy?
      instructions:
      - text: Show the password requirements for this user.
      - text: List the password complexity rules.
      method: generated
      generated: '2026-09-26'