Autentisering, behörigheter och säkra autentiseringsuppgifter

Välj autentiseringsuppgifter för anroparen

Använd OAuth i webbläsaren för en agent: användaren loggar in och väljer åtkomst, och CLI lagrar och förnyar sina uppgifter. För ett serverbaserat skript eller CI-jobb anger du en personlig åtkomsttoken via VICKY_API_KEY. Håll autentiseringsuppgifter borta från webbläsarkod, offentliga kodarkiv, promptar, skärmbilder och delade loggar.

HTTP-exemplen använder SOSOAPI_ACCESS_TOKEN som serverbaserad miljövariabel för Bearer-värdet. Det är en exempelvariabel, ingen CLI-inställning. Kontrollera uppgifterna som anges för varje åtgärd; personliga åtkomsttoken kan inte hantera API-nycklar.

npx sosoapi auth login

npx sosoapi auth status

npx sosoapi auth logout

• Fullständig API-referens

Omfång och funktioner

Varje anrop kontrollerar arbetsytemedlemskap och rollen som åtgärden kräver. Delegerad OAuth begränsar även åtkomsten till arbetsytor och funktioner som användaren valt. agent:operate omfattar läsning och förberedelse, agent:publish omfattar schemaläggning och publicering och agent:engage omfattar communityskrivningar. Hantering av API-nycklar kräver separat behörighet.

En personlig åtkomsttoken begränsas av ägarens roll och eventuella lagrade funktions- eller arbetsytebegränsningar. Välj endast åtkomsten som integrationen behöver; att utelämna valfria gränser kan ge nyckeln bred åtkomst. Profilerna core och full ändrar verktygslistan som visas, inte behörigheterna. Publiceringsåtkomst fortsätter inom beviljat omfång utan ett nytt webbläsargodkännande för varje inlägg.

Lagring och återkallande av inloggningsuppgifter

CLI lagrar autentiseringsuppgifter i operativsystemets nyckelring när den finns eller i en lokal fil som endast ägaren kan läsa. OAuth-åtkomsttoken gäller en timme och förnyas av inloggningsflödet. Använd auth status för att felsöka en anslutning i stället för att kopiera uppgiftsfilen.

Återkalla en enhet eller auktorisering i Inställningar → Agenter och API-åtkomst eller kör auth logout för att logga ut aktuell lokal enhet. Detta stoppar framtida åtkomst. Det återställer inte publicerade inlägg och avbryter inte schemaläggningar som SosoAPI redan har accepterat; kontrollera och hantera dem separat.

Slutpunkter för inledande autentisering

De fyra agent-auth-slutpunkterna dokumenterar inloggningsprotokollet. Använd stödd CLI eller en fjärr-OAuth-klient för att logga in; slutpunkterna är inte tillgängliga via api post. Config, request, session och revoke-current godtar olika uppgifter och fält. Följ varje slutpunkts schema och håll sessionsuppgifter borta från utdata och loggar.

• Referens för autentiseringsslutpunkter