API: Omówienie kluczy API i często zadawane pytania
Klucze interfejsu programowania aplikacji (API) służą do uwierzytelniania w interfejsach API serwisu Apptio bez konieczności podawania danych logowania użytkownika. Klucz API zawiera parę kluczy, w skład której wchodzi klucz publiczny i klucz tajny. Ta para kluczy publicznego i prywatnego służy jako dane uwierzytelniające do weryfikacji żądań. Każdy klucz API może mieć maksymalnie dwie pary kluczy. Po utworzeniu nowego klucza API tworzona jest para kluczy. Można dodać lub usunąć maksymalnie dwie pary kluczy. Klucze API zapewniają następujące korzyści:
- Bezpieczeństwo: Klucze API są generowane losowo i składają się z dłuższych ciągów znaków. Klucze API serwisu Apptio mają długość 60 znaków. Wyższa entropia utrudnia atakującym przejęcie kontroli nad systemem.
- Niezależność: W przypadku wywołań programowych korzystanie z klucza API zapobiega ujawnieniu danych logowania do konta głównego (czyli nadrzędnego konta użytkownika) innym użytkownikom w systemie (np. współpracownikom).
- Ograniczony dostęp: Klucz tajny jest ujawniany użytkownikowi wyłącznie podczas tworzenia klucza API. Użytkownik powinien bezpiecznie przechowywać klucz tajny. W przypadku utraty lub ujawnienia klucza tajnego można wygenerować nowy klucz.
- Rotacja kluczy: Możliwość korzystania z dwóch aktywnych par kluczy pozwala użytkownikom na rotację tych par bez zakłócania działania automatyzacji ani dostępu programowego. Zasady rotacji kluczy API można skonfigurować w oknie „Właściwości domeny”.
- Identyfikowalność: Klucze API są zawsze powiązane z nadrzędnym kontem użytkownika i zapewniają taki sam poziom identyfikowalności, jak zwykła sesja interaktywna.
Kto może tworzyć klucze API?
Ustawienia kluczy API w sekcji „Właściwości domeny” określają, czy dana domena obsługuje klucze API, a jeśli tak, to kto może je tworzyć. Jeśli klucze API są włączone, administratorzy mogą tworzyć klucze API dla siebie i innych użytkowników. Jeśli opcja „Ogranicz tworzenie kluczy API” ma wartość „false”, każdy użytkownik może tworzyć klucze API dla swojego konta.
Tworzenie kluczy API i zarządzanie nimi
Aby utworzyć klucze API dla swojego konta lub zarządzać nimi, kliknij przycisk „Profil” u góry strony, wybierz opcję „Profil użytkownika”, a następnie kliknij zakładkę „Klucze API”. Aby utworzyć klucze API dla innego użytkownika lub zarządzać nimi, kliknij przycisk „Strona główna” w lewym panelu nawigacyjnym, wybierz domenę użytkownika, a następnie znajdź go w tabeli. Kliknij „Szczegóły”, a następnie przejdź do zakładki „Klucze API”.
Utwórz klucz API- W zakładce „Klucz API” kliknij opcję „Utwórz klucz API ”.
- Wpisz nazwę klucza i opis.
- Wybierz zasady wygasania, a następnie kliknij „Dodaj ”.
- Zapisz klucz publiczny. Wybierz opcję „Pokaż”, aby wyświetlić klucz tajny. Tajny klucz można wyświetlić wyłącznie podczas tworzenia klucza API. Ten klucz będzie potrzebny podczas uwierzytelniania programowego. Zapisz klucz tajny w bezpiecznym miejscu.
- Wybierz jedną z poniższych opcji:
- Gotowe. Wróć do strony użytkowników i przyznaj dostęp klucza API do środowisk w późniejszym terminie.
- Przyznaj dostęp: Wybierz z listy środowisk, do których użytkownik ma już dostęp, a następnie kliknij Dalej. Wybierz jedną lub więcej ról dla klucza API. Kliknij przy cisk Dalej, a następnie wybierz opcję „Przyznaj dostęp ”.
- W zakładce „Klucze API ” wybierz jedną z poniższych opcji:
- Pokaż pary kluczy: Wyświetl lub ukryj klucze publiczne oraz daty wygaśnięcia (opcja ta jest dostępna wyłącznie w widoku profilu).
- Przyznaj dostęp: Wybierz z listy środowisk, do których użytkownik ma już dostęp, a następnie kliknij Dalej. Wybierz jedną lub więcej ról dla klucza API. Kliknij przy cisk Dalej, a następnie wybierz opcję „Przyznaj dostęp ”.
- Wyłącz: Wyłącz klawisz.
- Kliknij klucz API, aby wyświetlić okienko szczegółów dla tego klucza:
- Właściwości – wyświetla nazwę, zasady rotacji oraz opis klucza API. Kliknij przycisk „Edytuj”, aby zmienić dowolną z tych wartości.
- Pary kluczy – wyświetla pary kluczy powiązane z kluczem API wraz z datami wygaśnięcia. Aby dodać parę kluczy, kliknij przycisk +. Aby usunąć parę kluczy, zaznacz pole wyboru na początku wiersza, a następnie kliknij przycisk Usuń.
- Dostęp – Wyświetla informacje o uprawnieniach związanych z kluczem API wraz z opcjami zmiany i cofnięcia dostępu.
Aby korzystać z kluczy API w swoich skryptach i programach, zapoznaj się z poniższymi tematami:
Najczęściej zadawane pytania dotyczące klucza API
Jakie są zasady dotyczące wygaśnięcia klucza API?Można to skonfigurować w oknie „Właściwości domeny ”.
Kto może tworzyć klucze API i zarządzać nimi?Można to skonfigurować w oknie „Właściwości domeny ”.
Jakie środowiska i role są dostępne dla kluczy API?
Klucze API mogą uzyskać dostęp do tych samych środowisk i ról, jakie posiada nadrzędny użytkownik w dowolnym środowisku w domenie tego użytkownika. Ze względów bezpieczeństwa klucze API nie mogą uzyskać dostępu do środowisk, które nie znajdują się w domenie nadrzędnej użytkownika, z wyjątkiem sytuacji, gdy użytkownik znajduje się w domenie dostawcy usług MSP. Użytkownicy w domenach dostawców usług MSP mogą przyznawać swoim kluczom API dostęp do środowisk w poddomenach odbiorców usług MSP, do których mają już dostęp.
Czy mogę rotować moje klucze API?Można utworzyć wiele kluczy API dla jednego konta użytkownika (użytkownika nadrzędnego), a każdy klucz API może mieć dwie pary kluczy. Wszystkie klucze są aktywne i ważne, o ile nie straciły już ważności lub nie zostały wyraźnie wyłączone lub usunięte. Funkcje te umożliwiają aktualizowanie skryptów i wykonywanie innych zadań cyklicznych przy użyciu nowej pary kluczy dla tego samego klucza API bez zakłóceń w działaniu. Po zaktualizowaniu skryptów możesz usunąć nieużywane i wygasłe pary kluczy.
Jeśli konto użytkownika nadrzędnego zostanie wyłączone, wszystkie powiązane klucze API również zostaną wyłączone.
Tak.
Czy istnieje dziennik audytowy dotyczący dostępu do API?Tak, klucze API są uwzględnione we wszystkich raportach z audytu.
Jakie parametry są wykorzystywane do szyfrowania sesji?
https:// TLS 1.2 AES256