Autentimine
Autendi HTTP API päringud organisatsiooni API-võtme või OAuthi juurdepääsutokeniga.
Saada iga POST /api/v1/* päringuga üks Beareri mandaat:
Authorization: Bearer <credential>Mandaat, mis algab prefiksiga aut_, on organisatsiooni API-võti. Kõiki teisi kontrollitakse OAuthi juurdepääsutokenina.
Organisatsiooni API-võtmed
Kasuta API-võtit CI-tööde, skriptide ja muude süsteemide jaoks, mis ei tegutse inimese nimel.
- Ava Organization → API keys. Võtmeid saavad hallata ainult omanikud ja administraatorid.
- Sisesta jaotises Create a key võtme nimi (Key name), näiteks „GitHub Actions“, ja klõpsa Generate key.
- Kopeeri võti kohe. Töölaud näitab seda ainult üks kord: „Copy this key now. You won't see it again.“
Authorization: Bearer aut_…Mida võti teha saab:
- See kuulub ühele organisatsioonile ja pääseb ligi kõigile selle projektidele.
- Sellel on kõik allpool loetletud õigused. Õiguste valikut ega aegumiskuupäeva pole.
- Sellega saab saata 1000 päringut tunnis.
- See töötab ainult HTTP API-s. AI-assistendid ühenduvad MCP-ga hoopis OAuthi kaudu.
Tabel API keys loetleb iga võtme nime, võtme alguse ja loomise aja järgi. Võtme peatamiseks klõpsa Revoke key: kõik, mis seda kasutab, lakkab kohe töötamast. Hoia võtmeid oma CI saladuste hoidlas, mitte kunagi päringu kehas ega lähtekoodihoidlas.
OAuthi juurdepääsutokenid
OAuthi juurdepääsutoken tegutseb selle inimese nimel, kes selle autoriseeris, ühes organisatsioonis. Seda kasutavad MCP-kliendid ja ka HTTP API aktsepteerib seda. Inimene peab endiselt selle organisatsiooni liige olema ja liige pääseb ligi ainult neile projektidele, mida ta saab avada. Omanikud ja administraatorid pääsevad ligi kõigile projektidele.
Juurdepääsutokenid kehtivad ühe tunni. Klient, mis küsis õigust offline_access, saab oma tokenit uuendada sinult uuesti küsimata.
Õigused
Iga toiming vajab ühte õigust. API-võtmetel on need kõik. OAuthi tokenil on need õigused, mis nõusolekuekraanil kinnitati.
| Õigus | Sõnastus nõusolekuekraanil | Toimingud |
|---|---|---|
autonomy:read | Read projects, test cases, runs and issues | Kõik list- ja get-toimingud, run.step_actions ja run.evidence |
autonomy:test_cases:write | Create and edit test cases | test_case.create, test_case.update_steps, test_case.archive |
autonomy:test_plans:write | Create and edit test plans | test_plan.create, test_plan.set_members |
autonomy:runs:write | Start runs | run.trigger |
autonomy:environments:write | Create and edit environments | environment.upsert |
autonomy:issues:write | File and update issues | issue.create, issue.comment, issue.set_status |
Token, millel pole toimingu jaoks vajalikku õigust, saab vastuseks 403 FORBIDDEN sõnumiga „This operation requires the <scope> scope.“ ja õigusega väljal details.scope. Toimingukataloog nimetab iga toimingu õiguse.
Autentimise vead
Puuduv, vigane, aegunud või kehtetu mandaat tagastab 401 koos veaga UNAUTHENTICATED:
1{2 "error": {3 "code": "UNAUTHENTICATED",4 "message": "Missing or invalid programmatic credentials."5 }6}Vastus sisaldab ka Beareri väljakutset, mille abil OAuthi kliendid autoriseerimisserveri üles leiavad:
WWW-Authenticate: Bearer resource_metadata="https://app.autonomyqa.com/.well-known/oauth-protected-resource/api/mcp"Ei leidnud?