Do rozhraní API Orchestrator můžete přistupovat prostřednictvím tokenů namísto používání autentizace vycházející z relace. Jako primární uživatel typu operátor můžete spravovat tokeny API. U každého uživatele můžete vytvořit více tokenů API.
Poznámka: U uživatelů s oprávněním pouze ke čtení podniku a podnikových specialistů MSP není povoleno ověřování na základě tokenů.
Ve výchozím nastavení jsou tokeny API aktivované. Chcete-li je deaktivovat, přejděte v portálu Operator do části
Vlastnosti systému (System Properties) a nastavte hodnotu systémové vlastnosti
session.options.enableApiTokenAuth
na
Není pravda (False).
Poznámka: Superuživatel v roli operátora by měl ručně odstranit uživatele neaktivního poskytovatele identity (IdP) ze služby Orchestrator, aby se zabránilo neautorizovanému přístupu prostřednictvím tokenu API.
Uživatelé mohou vytvářet, odvolávat a stahovat tokeny na základě svých rolí.
Správa tokenů API:
- V portálu operátora přejděte do nabídky .
- Vyberte uživatele a klikněte na možnost Modifikovat (Modify) nebo klikněte na odkaz na uživatelské jméno. Přejděte do části Tokeny API (API Tokens).
- Klikněte na možnost Nový token API (New API Token).
- V okně Nový token (New Token) zadejte Název (Name) a Popis (Description) tokenu a poté z rozbalovací nabídky vyberte parametr Životnost (Lifetime).
- Klikněte na tlačítko Uložit (Save). Nový token se zobrazí v tabulce Tokeny API (API Tokens). Zpočátku se použije stav tokenu Čeká na vyřízení (Pending). Po stažení se stav změní na Povoleno (Enabled).
- Chcete-li stáhnout token, vyberte token a klikněte na možnost Stáhnout token API (Download API Token).
- Chcete-li token deaktivovat, vyberte token a poté klikněte na možnost Odvolat token API (Revoke API Token). Stav tokenu se změní na Odvoláno (Revoked).
- Kliknutím na možnost CSV stáhnete kompletní seznam tokenů API ve formátu souboru .csv.
- Po vypršení platnosti tokenu se stav změní na Prošlý (Expired).
Poznámka: Token může stáhnout pouze uživatel, kterému je token přiřazen, a po stažení bude možné zobrazit pouze ID tokenu. Token je možné stáhnout pouze jednou. Po stažení tokenu jej uživatel může odeslat jako součást autorizačního záhlaví požadavku na přístup k rozhraní API aplikace Orchestrator.
Následující příklad popisuje vzorový fragment kódu pro přístup k rozhraní API.
curl -k -H "Authorization: Token <Token>" -X POST https://vco/portal/ -d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'
Podobně můžete konfigurovat další vlastnosti a vytvořit tokeny API pro administrátory partnera, podnikové zákazníky a zákazníky partnera. Další informace naleznete zde:
- Téma „Uživatelé – zákazník“ v dokumentu Příručka pro správce VMware SD-WAN
- Téma „Uživatelé – Partner“ v dokumentu Příručka pro partnery VMware SD-WAN
Následují další možnosti dostupné v oblasti
Tokeny API (API Tokens):
Možnost | Popis |
---|---|
Vyhledat (Search) | Zadejte výraz pro vyhledání odpovídajícího textu v tabulce. Pomocí možnosti rozšířeného vyhledávání můžete zúžit výsledky vyhledávání. |
Sloupce (Columns) | Klikněte a vyberte sloupce, které se mají na stránce zobrazit nebo skrýt. |
Obnovit (Refresh) | Kliknutím obnovíte stránku a zobrazíte nejaktuálnější data. |