Ontwikkelaarsdocumentatie
Authenticatie, machtigingen en veilige inloggegevens
Meld een agent aan met OAuth, gebruik een persoonlijk toegangstoken op je server en kies de benodigde machtigingen per aanroeper.
Lezen als MarkdownBeoordeeld door het SosoAPI-team ·
Kies inloggegevens voor de aanroeper
Gebruik voor een agent OAuth in de browser: de gebruiker meldt zich aan en kiest toegang; de CLI slaat inloggegevens op en vernieuwt ze. Geef voor een backendscript of CI-taak een persoonlijk toegangstoken mee via VICKY_API_KEY. Houd inloggegevens uit browsercode, openbare repositories, prompts, screenshots en gedeelde logs.
De HTTP-voorbeelden gebruiken SOSOAPI_ACCESS_TOKEN als serveromgevingsvariabele voor de Bearer-waarde. Dit is een voorbeeldvariabele, geen CLI-instelling. Controleer de inloggegevens per bewerking; persoonlijke toegangstokens kunnen geen API-sleutels beheren.
npx sosoapi auth loginnpx sosoapi auth statusnpx sosoapi auth logoutBereik en bevoegdheden
Elk verzoek controleert werkruimtelidmaatschap en de vereiste rol voor de bewerking. Gedelegeerde OAuth beperkt toegang ook tot de door de gebruiker gekozen werkruimten en bevoegdheden. agent:operate omvat lezen en voorbereiden, agent:publish omvat inplannen en publiceren en agent:engage omvat communityschrijfhandelingen. API-sleutels beheren vereist een aparte machtiging.
Een persoonlijk toegangstoken is beperkt door de rol van de eigenaar en opgeslagen bevoegdheids- of werkruimtebeperkingen. Kies alleen de toegang die je integratie nodig heeft; optionele beperkingen weglaten kan een sleutel ruime toegang geven. De profielen core en full wijzigen de zichtbare toollijst, niet de machtigingen. Publicatietoegang loopt binnen het toegestane bereik door zonder nieuwe browsergoedkeuring per bericht.
Opslag en intrekking van inloggegevens
De CLI bewaart inloggegevens waar mogelijk in de sleutelhanger van je besturingssysteem, anders in een lokaal bestand dat alleen de eigenaar kan lezen. OAuth-toegangstokens zijn één uur geldig en worden door de aanmeldprocedure vernieuwd. Gebruik auth status voor verbindingsdiagnose in plaats van het inloggegevensbestand te kopiëren.
Trek een apparaat of autorisatie in via Settings → Agents & API Access of voer auth logout uit om het huidige lokale apparaat af te melden. Dit stopt toekomstige toegang. Het maakt gepubliceerde berichten niet ongedaan en annuleert geen reeds door SosoAPI geaccepteerde planningen; controleer en beheer die apart.
Endpoints voor het opstarten van authenticatie
De vier agent-auth-endpoints documenteren het aanmeldprotocol. Gebruik de ondersteunde CLI of een externe OAuth-client om aan te melden; deze endpoints zijn niet via api post beschikbaar. Config, request, session en revoke-current accepteren verschillende inloggegevens en velden. Volg elk endpointschema en houd sessie-inloggegevens uit uitvoer en logs.