API tokeny

Autentizace skriptů, CI a integrací pomocí API tokenů.

API token autentizuje požadavky na Futrou API a Futrou CLI bez osobního přihlášení — hodí se pro CI pipeline, skripty a integrace třetích stran.

  • Workspace token přežije i smazání svého tvůrce — je stavěný na automatizaci, ne na to, aby patřil konkrétnímu člověku.
  • Ve výchozím stavu dlouhodobě platný — nastavte datum expirace, nebo ho nechte bez omezení až do zneplatnění.
  • Používejte co nejužší roli a rozsah projektů, které danou úlohu splní.
  • Zobrazí se jen jednou, při vytvoření — zkopírujte si ho na bezpečné místo, protože znovu ho zobrazit nepůjde. Ztratili jste ho? Zneplatněte ho a vytvořte nový.

Typy

  • Workspace — patří workspacu, obchází 2FA.
  • Uživatelský — patří uživateli, vyžaduje 2FA.
  • Serverový — patří samostatnému serveru Futrou Nasua, obchází 2FA.

Role

API tokeny používají stejné role jako členové workspacu. Uživatelský token nese vaši vlastní roli v každém workspacu, jehož jste členem; workspace token má roli přiřazenou přímo a lze ho volitelně omezit na konkrétní projekty, stejně jako u člena. Více na stránce Role.

Workspace API tokeny {#workspace-api-tokeny}

Vytváří se ručně v Nastavení workspacu → API tokeny, pro dlouhodobé použití jako CI pipeline a integrace, které by neměly záviset na účtu konkrétní osoby. Integrace třetí strany si o něj může požádat také přímo přes OAuth2, když ji autorizujete pro workspace místo pro sebe.

Uživatelské API tokeny {#uzivatelske-api-tokeny}

Vytváří se automaticky po přihlášení pomocí přihlašovacích údajů nebo OAuth2 — nic se nevytváří ručně. Funguje jako vy:

  • Vyžaduje 2FA, pokud ho máte zapnuté.
  • Uděluje přístup ke každému workspacu, jehož jste členem, s vaší vlastní rolí v každém z nich.
  • Umí vytvářet další API tokeny (viz poznámka níže).
  • Krátkodobě platný, automaticky obnovovaný, dokud jste přihlášeni, a přestane fungovat po smazání účtu.

Serverové API tokeny {#serverove-api-tokeny}

Samostatný server Futrou Nasua si vydává vlastní tokeny nezávisle na Futrou Cloud — slouží k autentizaci vůči API daného serveru, když do hry nevstupuje žádný workspace.

Použití

Token předejte Futrou CLI přes --api-token, nebo proměnnou prostředí FUTROU_API_TOKEN, místo interaktivního přihlašování:

bash
futrou --api-token $FUTROU_API_TOKEN serverlets list

Nebo ho pošlete přímo na API jako bearer token:

bash
curl -H "Authorization: Bearer $FUTROU_API_TOKEN" https://api.futrou.com/v2/serverlets

Naposledy upraveno