Zarządzanie kluczami API
Klucz interfejsu API jest unikatowym identyfikatorem służącym do uwierzytelniania użytkownika, programisty lub programu wywołującego w interfejsie API. Klucze interfejsu API są często używane do śledzenia i kontrolowania sposobu używania interfejsu API, aby zapobiec jego nadużyciom.
Przegląd kluczy API
Klucze interfejsu API są domyślnie wyłączone w funkcji Konsola zarządzania. Aby włączyć klucze interfejsu API, przejdź do sekcji Ustawienia. Administrator dzierżawy może odwołać klucze interfejsu API, ale do edytowania ustawień kluczy interfejsu API oraz generowania i usuwania kluczy interfejsu API wymagana jest rola programisty. Rolę programisty przypisuje użytkownikom administrator dzierżawy. Jeżeli jesteś administratorem dzierżawy, możesz przypisać rolę programisty sobie.
Tabela kluczy interfejsu API zawiera następujące informacje o kluczach interfejsu API: nazwa, identyfikator, właściciel, ostatnia aktualizacja, data utworzenia, data wygaśnięcia i status. Użyj pola wyszukiwania, aby wyszukać w pierwszych trzech polach: Nazwa klucza Identyfikator klucza i Właściciel.
Statusy kluczy interfejsu API
Klucze interfejsu API mogą mieć następujące statusy:
- Aktywny: klucz interfejsu API jest w użyciu.
- Wygasły: data wygaśnięcia minęła.
- Odwołany: klucz interfejsu API został odwołany i nie można go już używać.
Jako administrator możesz przejrzeć działania z kluczami interfejsu API zarejestrowane w sekcji Zdarzenia w funkcji Konsola zarządzania. W przypadku wykrycia podejrzanych działań, takich jak intensywne korzystanie z niektórych kluczy interfejsu API, możesz odwołać dany klucz interfejsu API. Otwórz szczegółową listę, klikając strzałkę po prawej stronie tabeli i skopiuj identyfikator klucza interfejsu API. Następnie możesz wyszukać identyfikator w sekcji Klucze API, aby znaleźć klucz interfejsu API do odwołania.
Aby odwołać pojedynczy klucz interfejsu API, kliknij przycisk ... po prawej stronie i wybierz polecenie Odwołaj. Odwoływać można klucze tylko ze statusem Aktywny. Aby odwołać wiele kluczy, zaznacz pola wyboru po lewej stronie kluczy do odwołania i kliknij polecenie Odwołaj w prawym górnym rogu. Odwołanie jest nieodwracalne, a odwołanego klucza interfejsu API nie można ponownie aktywować.
Oprócz odwołania istnieje również opcja usuwania. Klucz interfejsu API można usunąć z huba, ale nie w funkcji Konsola zarządzania.
Włączanie kluczy API w dzierżawie
Ustawienie Włącz klucze API włącza się w funkcji Konsola zarządzania na stronie Ustawienia. Klucze interfejsu API są domyślnie wyłączone w funkcji Konsola zarządzania.
Właściwość | Opis |
---|---|
Włącz klucze API |
Ten przełącznik włącza lub wyłącza wszystkie klucze API w dzierżawie. Klucze interfejsu API może włączyć tylko administrator dzierżawy. |
Zmień maksymalny termin wygaśnięcia tokenu |
Zmiana wartości wygaśnięcia tokenu powoduje, że wszystkie nowe tokeny będą opatrzone nową wartością wygaśnięcia. Zmiana nie obejmie istniejących interfejsów API, w których wartość wygaśnięcia nie zostanie zmodyfikowana. |
Zmień maksymalną liczbę kluczy interfejsu API na użytkownika |
To ustawienie wpływa tylko na nowe klucze interfejsu API. Jeżeli łączna liczba kluczy interfejsu API przekroczy liczbę maksymalną po dodaniu nowego klucza, nastąpi odmowa utworzenia. |
Wykonaj następujące czynności:
- W funkcji Konsola zarządzania przejdź do strony Ustawienia.
- W sekcji Klucze API włącz przycisk Włącz klucze API.
- W razie potrzeby zmień ustawienia Zmień maksymalny termin wygaśnięcia tokenu i Zmień maksymalną liczbę kluczy interfejsu API na użytkownika.
Generowanie klucza interfejsu API z huba
Klucze interfejsu API można generować z huba. Najpierw sprawdź, czy są spełnione następujące trzy wymagania:
-
Używasz licencji. Do wygenerowania klucza API wymagana jest licencja.
- Ustawienie Włącz klucze API włącza się w funkcji Konsola zarządzania.
- Administrator dzierżawy przypisał Ci rolę programisty.
Wykonaj następujące czynności:
-
Zaloguj się do dzierżawy, na przykład pod adresem https://<tenantname>.com.
-
Kliknij swój profil w prawym górnym rogu i wybierz pozycję Ustawienia profilu.
-
Wybierz pozycję Klucze API.
-
Kliknij pozycję Wygeneruj nowy klucz.
-
Wprowadź opis klucza interfejsu API i wybierz, kiedy klucz API ma wygasnąć.
-
Kliknij przycisk Generuj.
Zostanie wygenerowany klucz interfejsu API.
-
Skopiuj klucz interfejsu API i zachowaj go w bezpiecznym miejscu.
Po utworzeniu możesz edytować nazwę klucza interfejsu API. Możesz go również usunąć.