Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Manager API Version 3.0 Auth Systems API

4 actions 4 updates phrasing extends openapi/tricentis-auth-systems-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/v3/auth-systems'].get

$.paths['/api/v3/auth-systems/ldap/{ldapAuthConfigId}/import'].post

$.paths['/api/v3/auth-systems/ldap/{ldapAuthConfigId}/users'].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 qTest Manager API Version 3.0 Auth Systems API
  version: 1.0.0
extends: openapi/tricentis-auth-systems-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: 3
- target: $.paths['/api/v3/auth-systems'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication systems
      effect: read
      questions:
      - Which authentication systems, like LDAP or SSO, are configured?
      - Can I see all auth system configurations on the instance?
      instructions:
      - text: List the configured authentication systems.
      - text: Show all LDAP and other auth configurations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/auth-systems/ldap/{ldapAuthConfigId}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Link users to LDAP accounts
      effect: write
      questions:
      - How do I associate existing users with their LDAP accounts?
      - Can I merge accounts when importing LDAP users?
      instructions:
      - text: Associate users with LDAP accounts from config {ldap}.
        slots:
          ldap: path.ldapAuthConfigId
      - text: Import LDAP users from config {ldap} with mergeUser={merge}.
        slots:
          ldap: path.ldapAuthConfigId
          merge: query.mergeUser
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/auth-systems/ldap/{ldapAuthConfigId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List unmapped LDAP users
      effect: read
      questions:
      - Which LDAP users haven't been mapped to an account yet?
      - Can I page through the users in an LDAP configuration?
      instructions:
      - text: List the LDAP users in config {ldap}.
        slots:
          ldap: path.ldapAuthConfigId
      - text: Show page {page} of unmapped LDAP users for config {ldap}.
        slots:
          ldap: path.ldapAuthConfigId
          page: query.page
      method: generated
      generated: '2026-10-01'