# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OAUTH Clients API
  version: 1.0.0
extends: openapi/qliksense-oauth-clients-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: 11
- target: $.paths['/api/v1/oauth-clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth clients in the tenant
      effect: read
      questions:
      - Which OAuth clients are registered in my Qlik Cloud tenant?
      - Can I filter and sort the OAuth client list and get a total count?
      instructions:
      - text: List all OAuth clients.
      - text: Show OAuth clients matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new OAuth client
      effect: write
      questions:
      - How do I register an OAuth client for a web app or SPA to connect to my tenant?
      - Can I change an OAuth client's app type after I create it?
      instructions:
      - text: Create an OAuth client named {clientName} of app type {appType}.
        slots:
          clientName: requestBody.clientName
          appType: requestBody.appType
      - text: Register {appType} OAuth client {clientName} with redirect URIs {redirectUris} and scopes {allowedScopes}.
        slots:
          appType: requestBody.appType
          clientName: requestBody.clientName
          redirectUris: requestBody.redirectUris
          allowedScopes: requestBody.allowedScopes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an OAuth client's details
      effect: read
      questions:
      - What redirect URIs and scopes does a particular OAuth client have?
      - Can I look up one OAuth client by its id?
      instructions:
      - text: Show OAuth client {id}.
        slots:
          id: path.id
      - text: Get the configuration of OAuth client {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth client
      effect: destructive
      questions:
      - What confirmation header do I need to delete an OAuth client?
      - How do I remove an OAuth client I no longer use?
      instructions:
      - text: Delete OAuth client {id}, confirming with {qlik-confirm-delete}.
        slots:
          id: path.id
          qlik-confirm-delete: header.qlik-confirm-delete
      - text: Remove OAuth client {id} for good, passing its id {qlik-confirm-delete} as confirmation.
        slots:
          id: path.id
          qlik-confirm-delete: header.qlik-confirm-delete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an OAuth client's settings
      effect: write
      questions:
      - Can I add client_secret as an auth method on an existing OAuth client and get a secret back?
      - How do I change redirect URIs or scopes on an OAuth client I already created?
      instructions:
      - text: Update the settings of OAuth client {id}.
        slots:
          id: path.id
      - text: Patch OAuth client {id} to add client_secret to its allowed auth methods.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}/actions/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an OAuth client to all tenants in a region
      effect: write
      questions:
      - How can a third-party app use the same client ID across every Qlik Cloud tenant in a region?
      - What does publishing an OAuth client change about which tenants can use it?
      instructions:
      - text: Publish OAuth client {id} so other tenants in the region can use it.
        slots:
          id: path.id
      - text: Share OAuth client {id} region-wide.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}/client-secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a new OAuth client secret
      effect: write
      questions:
      - How many client secrets can one OAuth client hold at once?
      - Can I rotate credentials by adding a second secret to an OAuth client?
      instructions:
      - text: Generate a new client secret for OAuth client {id}.
        slots:
          id: path.id
      - text: Add another secret to OAuth client {id} for rotation.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}/client-secrets/{hint}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an OAuth client secret
      effect: destructive
      questions:
      - How do I revoke one old secret on an OAuth client without deleting the client?
      - Can I remove a specific client secret by its hint?
      instructions:
      - text: Delete secret {hint} from OAuth client {id}.
        slots:
          hint: path.hint
          id: path.id
      - text: Revoke client secret {hint} on OAuth client {id}.
        slots:
          hint: path.hint
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}/connection-configs/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my tenant's consent config for an OAuth client
      effect: read
      questions:
      - What consent method is my tenant using for a given OAuth client?
      - Is an OAuth client's connection config enabled for my tenant?
      instructions:
      - text: Show my tenant's connection config for OAuth client {id}.
        slots:
          id: path.id
      - text: Get the consent method and status for OAuth client {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}/connection-configs/me'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove my tenant's connection config for a client
      effect: destructive
      questions:
      - How do I clear my tenant's consent configuration for an OAuth client?
      - Can I drop the connection config for one client without deleting the client itself?
      instructions:
      - text: Delete my tenant's connection config for OAuth client {id}.
        slots:
          id: path.id
      - text: Reset the consent settings my tenant holds for OAuth client {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/oauth-clients/{id}/connection-configs/me'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the consent method for an OAuth client
      effect: write
      questions:
      - Can I switch an OAuth client to a different consent method after creating it?
      - Where do I update the consent method my tenant applies to an OAuth client?
      instructions:
      - text: Update the consent method on my tenant's connection config for OAuth client {id}.
        slots:
          id: path.id
      - text: Change how users consent to OAuth client {id} in this tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'