REST API, marķieri un audita eksports

API

API ir versionēts zem /api/v1, un tas ir tas pats API, ko lieto paša produkta ekrāni. Kļūdām ir viena forma, un tās tiek atgrieztas izsaucēja valodā (angļu, latviešu vai vācu). API ir aprakstīts OpenAPI formātā, un aprakstu veido pats kods. Produkta API lapā ir uzskaitīti izsaukumi, un turpat aprakstu var lejupielādēt kā OpenAPI (JSON); lapu atver saite Ko piedāvā API pie jūsu API marķieriem. To pašu aprakstu adresē /api/v1/openapi saņem ikviens, kas ir pieteicies vai uzrāda marķieri. REST API izsaukumu biežums uz vienu marķieri nav ierobežots.

Servisa konti

Citai sistēmai, kurai jārunā ar GoProject, bez kāda cilvēka paroles. Administrēšana, Servisa konti, Jauns konts: nosaukums un tas, kam konts domāts. Kontam nav paroles, un tas nevar izmantot pieteikšanās ekrānu. Pievienojiet to projektu lomām kā cilvēku; tas nosaka, ko tas drīkst.

Pēc tam Izsniegt marķieri:

• Parādīts vienu reizi; glabājas tikai jaucējvērtība. Pazaudēts nozīmē izsniegt jaunu un veco atsaukt
• Iespējas: Tikai šie projekti un Drīkst tikai lasīt tikai sašaurina to, ko konts drīkst; Drīkst lasīt audita izvilkumu atver zemāk aprakstīto audita eksportu un neko citu no administrēšanas; Atver MCP serveri ļauj marķieri lietot AI aģentam
• Derīguma termiņš ir obligāts. Griesti visiem marķieriem pēc noklusējuma ir 365 dienas; to pazeminot, saīsinās marķieri, kas jau ir garāki
• Katrs marķieris rāda savu derīguma termiņu, izmantošanas reižu skaitu un pēdējo izmantošanu. Audita žurnālā tiek ierakstīts, kurš marķieris ko darīja, un sistēma brīdina, kad dzīvam marķierim atlicis mazāk par 14 dienām

Personīgie API marķieri

Profils, Drošība, API marķieri, Jauns marķieris. Marķieris darbojas sava īpašnieka vārdā, atskaitot to, ko atņem tā tvērums (tikai lasīšana, daži projekti), ar derīguma termiņu līdz administratora noteiktajam ierobežojumam. Vienam cilvēkam ne vairāk kā desmit dzīvi marķieri, ārējiem kontiem tie nav pieejami, un īpašnieks par jauna marķiera izveidi saņem vēstuli. Administratori redz katru personīgo marķieri un var tos atsaukt vai personīgos marķierus izslēgt sadaļā Administrēšana, Servisa konti.

Marķiera lietošana

curl -H "Authorization: Bearer gop_..." https://goproject.example.com/api/v1/spaces

Pieprasījums ar marķieri neizveido sesiju, un CSRF marķieris tam nav vajadzīgs. Nepareizs, atsaukts, beidzies vai izslēgts marķieris atbild ar 401 bez paskaidrojuma. Marķieri neatver /api/v1/admin/ nekad, lai ko kontam būtu; vienīgais izņēmums ir audita eksports ar servisa konta marķieri, kam izsniedzot atzīmēts Drīkst lasīt audita izvilkumu.

Tīmekļa āķu izsaukumi

Tīmekļa āķu abonēšanas ekrāna nav. Izejošos izsaukumus veic automatizācijas noteikumi: ar darbību "sūtīt tīmekļa pieprasījumu" vai ar Slack vai Teams ziņu. Ienākošie izsaukumi modina automatizācijas noteikumus pa to slepenajām ienākošo tīmekļa āķu adresēm, Git serveri izsauc izstrādes tīmekļa āķu adreses, un, ja Microsoft Teams ir pieslēgts tieši, Teams izsauc produkta botu. Skatiet Automatizācija un tās aizsargi un Git integrācijas.

Audita eksports SIEM sistēmai

GET /api/v1/admin/audit/export?afterId=0&limit=1000

Atgriež ar jaunrindām atdalītu JSON (application/x-ndjson), vecākos vispirms, līdz 10 000 ierakstiem vienā izsaukumā. Atbildes galvene X-Last-Id ir kursors: nododiet to kā afterId nākamajā izsaukumā. Eksportu izsauc ar servisa konta marķieri, kam izsniedzot atzīmēts Drīkst lasīt audita izvilkumu, vai no sistēmas administratora pieteiktās sesijas (Administrēšana, Audita žurnāls, Eksportēt (JSONL)). Tajā pašā ekrānā var ieslēgt arī katra notikuma pārsūtīšanu, tiklīdz tas pierakstīts: uz syslog serveri vai dienas failā ar JSON rindām. Žurnāls ir tikai papildināms: ierakstus nekad ne labo, ne dzēš.