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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for qTest Parameters Authentication API
version: 1.0.0
extends: openapi/tricentis-authentication-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['/oauth/v1/login'].post
update:
x-apievangelist-phrasing:
intent: Sign in with a username and password
effect: write
questions:
- How do I get an access token using my qTest username and password?
- Which qTest Manager URL do I pass when logging in?
instructions:
- text: Log in to {qtest_url} as {username} with password {password}.
slots:
qtest_url: requestBody.qtest_url
username: requestBody.username
password: requestBody.password
- text: Get an access token for user {username} on {qtest_url}.
slots:
username: requestBody.username
qtest_url: requestBody.qtest_url
method: generated
generated: '2026-10-01'
- target: $.paths['/oauth/v1/token-login'].post
update:
x-apievangelist-phrasing:
intent: Sign in with a qTest API token
effect: write
questions:
- Can I authenticate with an API token instead of a password?
- What do I exchange my qTest Manager API token for?
instructions:
- text: Exchange API token {qtest_token} for an access token on {qtest_url}.
slots:
qtest_token: requestBody.qtest_token
qtest_url: requestBody.qtest_url
- text: Authenticate to {qtest_url} using my API token.
slots:
qtest_url: requestBody.qtest_url
method: generated
generated: '2026-10-01'
- target: $.paths['/oauth/v1/logout'].get
update:
x-apievangelist-phrasing:
intent: Log out of qTest
effect: destructive
questions:
- How do I end my current qTest session?
- Can I sign out so my access token stops working?
instructions:
- text: Log me out of qTest.
- text: End my current authenticated session.
method: generated
generated: '2026-10-01'
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. See our Privacy Policy and
Terms.