Integracja aplikacji niestandardowych

Kroki do integracji ADManager Plus z niestandardową aplikacją

1. Zaloguj się do ADManager Plus.
2. Przejdź do Automatyzacja > Konfiguracja > Integracje aplikacji.
3. W sekcji Aplikacje korporacyjne kliknij kafel Aplikacje niestandardowe, aby zintegrować nową aplikację.
4. W oknie, które się pojawi, wprowadź odpowiednią nazwę i opis, załaduj logo aplikacji i kliknij Zapisz.
5. Kliknij niestandardową aplikację dodaną w poprzednim kroku, aby skonfigurować metody autoryzacji API, punkty końcowe i webhooki.
6. W sekcji Autoryzacja wybierz Rodzaj autoryzacji z rozwijanego menu:



• Brak autoryzacji

  Wybierz Brak autoryzacji jako Rodzaj autoryzacji, jeśli Twoje żądanie nie wymaga autoryzacji, a następnie kliknij Skonfiguruj. Jeśli to zrobisz, szczegóły autoryzacji nie będą udostępniane klientowi API.

• Klucz API

  Jeśli wybierzesz Klucz API jako Rodzaj autoryzacji, wprowadź nazwę i wartość klucza w odpowiednich polach Klucz i Wartość. Powiąż klucz z nagłówkiem lub parametrem zapytania, używając rozwijanego menu Dodaj do, a następnie kliknij Skonfiguruj. Możesz odwołać się do dokumentacji API swojej aplikacji, aby uzyskać więcej szczegółów.

• Podstawowa autoryzacja

  Jeśli wybierzesz Podstawową autoryzację jako Rodzaj autoryzacji, określ Nazwę użytkownika i Hasło, a następnie kliknij Skonfiguruj.

• Bearer

  Jeśli wybierzesz Bearer jako Typ autoryzacji, wprowadź klucz API swojej aplikacji w polu Token i kliknij Konfiguruj. Klucz API można uzyskać, postępując zgodnie z krokami opisanymi w dokumentacji API Twojej aplikacji.

• OAuth 2.0

  Jeśli wybierzesz OAuth 2.0 jako Typ autoryzacji, określ następujące:

  • Prefiks nagłówka: Określ wartość prefiksu dla swojego nagłówka autoryzacyjnego.
  • Typ przyznania: Kod autoryzacji jest domyślnym Typem przyznania, ale możesz wybrać Dane poświadczeń klienta jako Typ przyznania w zależności od aplikacji.
  • URL przekierowania: URL przekierowania to miejsce, do którego zostaniesz przekierowany po autoryzacji. Dla aplikacji z listy, jest on wypełniony automatycznie URL-em ADManager Plus.

    Na przykład: http://{hostname}/OAuthCode.do. Nazwa hosta będzie maszyną, na której zainstalowano instancję ADManager Plus.

    Podczas integracji nowej aplikacji, powinno to być skonfigurowane w konfiguracji OAuth dostawcy API.

  • URL autoryzacji: Określ URL punktu końcowego autoryzacji uzyskanego z aplikacji, z którą chcesz się zintegrować podczas konfigurowania szczegółów OAuth. Możesz odwołać się do dokumentu API aplikacji po więcej informacji.
  • URL tokena dostępu: Wprowadź URL serwera OAuth, gdzie aplikacja może wymienić kod autoryzacji na token dostępu. URL serwera będzie URI przekierowania aplikacji. Odwołaj się do dokumentacji API, aby uzyskać kroki dotyczące uzyskania URI przekierowania aplikacji, z którą integrujesz.
  • ID klienta oraz Tajny klucz klienta: Wprowadź ważne ID i jego tajny klucz uzyskany z aplikacji, z którą chcesz się zintegrować z ADManager Plus.
  • Zakres: Zakresy są zdefiniowane w dokumentacji API aplikacji, z którą się integrujesz. Ogranicza to dostęp klienta do specificznych punktów końcowych i określa, czy klient może tylko czytać, czy również pisać do tych punktów. Określ wartości zakresu w ADManager Plus po zapoznaniu się z wartościami zakresu w dokumentacji API.
  • Autoryzacja klienta: Możesz użyć tej opcji, aby wybrać, czy dane poświadczenia klienta mają być uwzględnione w ciele żądania, czy w nagłówku. Domyślnie wybrane będzie Wyślij dane poświadczeń klienta w ciele żądania.
  • Opcje zaawansowane: Kliknij tę opcję i wybierz nagłówki lub parametry zapytania z rozwijanego menu Dodaj do.

Webhook przychodzący umożliwia transfer danych z niestandardowej aplikacji do ADManager Plus. Aby to skonfigurować:

1. W sekcji Webhook przychodzący, kliknij <Konfiguracja punktu końcowego niestandardowej aplikacji>, aby dostarczyć szczegóły punktu końcowego wymienione poniżej. W razie potrzeby możesz skonfigurować wiele punktów końcowych dla niestandardowej aplikacji, używając przycisku + Dodaj punkt końcowy API.

   

   • Adres URL punktu końcowego: Wprowadź Adres URL punktu końcowego. Adres URL punktu końcowego będzie różnił się w zależności od operacji, która ma zostać wykonana, oraz typu danych, które mają zostać pobrane z aplikacji.
     • Na przykład: Adres URL punktu końcowego używany do pobierania danych użytkownika będzie różny od adresu URL używanego do pobierania danych grupy. Odwołaj się do dokumentacji API aplikacji, z którą integrujesz ADManager Plus.
   • Metoda: Wybierz Get lub Post jako metodę żądania HTTP.
   • Nagłówki: Kliknij i skonfiguruj odpowiednie nagłówki HTTP.
   • Parametry: Kliknij i skonfiguruj parametry zapytania.
   • Typ wiadomości: Wybierz typ danych wiadomości z dostępnych opcji w zależności od typu API:
     • JSON: Ta opcja jest przeznaczona dla API REST.
     • XML: Ta opcja jest przeznaczona dla API SOAP.
     • Brak: Jest to opcja domyślna.

     Uwaga: Wykonaj te kroki, aby skonfigurować zaawansowane ustawienia.

2. W opcji Konfiguracja powtarzania wywołań wybierz typ akcji z listy podanej w pierwszym rozwijanym menu. W sąsiednim rozwijanym menu podaj parametry paginacji, aby uzyskać dane w uporządkowanych zestawach, aż cały zbiór danych zostanie pobrany. Wprowadź wartość parametrów paginacji w polu Wartość.
3. Możesz także ustawić warunek przy użyciu opcji Kryteria powtarzania wywołań, aby określić, jak długo API musi być wywoływane.
4. Po zakończeniu kliknij Testuj i zapisz. Okno odpowiedzi wyświetli wszystkie żądane elementy.
5. Kliknij Źródło danych - Mapowanie atrybutów LDAP, aby dopasować punkty końcowe oraz zmapować atrybuty AD LDAP z odpowiednimi atrybutami aplikacji dostosowanej.

   Uwaga: Kliknij Dodaj nowy format nazw, aby utworzyć nowy format nazw dla atrybutów nazw użytkowników w aplikacji dostosowanej. W oknie pop-up Custom Naming format, wypełnij szczegóły i kliknij Zapisz.

   

   

   • Wprowadź Nazwę konfiguracji i Opis, a następnie wybierz Kategorię automatyzacji z rozwijanego menu.
   • W polu Wybierz punkt końcowy zaznacz pole punktu końcowego aplikacji dostosowanej, a w rozwijanym menu Klucz główny wybierz atrybut, który jest unikalny dla użytkowników (employeeIdenifier, username, itp.), ale zachowuje tę samą wartość we wszystkich punktach końcowych.
   • W polu Mapowanie atrybutów wybierz atrybut z rozwijanego menu Nazwa atrybutu LDAP i zmapuj go z odpowiednim atrybutem aplikacji dostosowanej.
6. Kliknij Zapisz.

Jak używać przychodzących webhooków

Po skonfigurowaniu przychodzącego webhooka możesz go używać jako źródła danych w zaplanowanych automatyzacjach dla różnych działań związanych z zarządzaniem tożsamością w ADManager Plus. Aby to zrobić, przejdź do Automatyzacja, kliknij + Utwórz nową automatyzację i użyj opcji Wybierz więcej w sekcji Wybierz obiekty. Umożliwia to automatyzację akcji, którą chcesz wykonać na liście obiektów importowanych za pośrednictwem webhooka przychodzącego, zarówno jednorazowo, jak i okresowo.

Zaawansowana konfiguracja punktów końcowych dla zagnieżdżonych punktów końcowych z webhookami przychodzącymi

W przypadku niektórych konfiguracji API może być konieczne skonfigurowanie wielu punktów końcowych, gdzie punkty końcowe są zależne od innych. Na przykład pierwszy punkt końcowy pobiera wszystkie identyfikatory pracowników w organizacji, a Ty musisz wywołać inne API dla każdego identyfikatora pracownika otrzymanego w odpowiedzi, aby pobrać szczegóły każdego pracownika. W takich przypadkach skonfiguruj pierwsze API jako punkt końcowy bazowy (domyślny typ) a drugi punkt końcowy jako punkt końcowy zależny, używając opcji Zaawansowane w sekcji Konfiguracja punktu końcowego.

Kroki do skonfigurowania punktu końcowego zależnego

Włącz przycisk Zaawansowane w sekcji Konfiguracja punktu końcowego API, aby wypełnić informacje, gdy punkt końcowy jest zależny od poprzedniego punktu końcowego API.

• W sekcji Konfiguracja punktu końcowego włącz opcję Zaawansowane, aby wypełnić informacje, gdy punkt końcowy jest zależny od wcześniejszego punktu końcowego API.
• W menu rozwijanym Typ konfiguracji wybierz typ punktu końcowego. Domyślnie wybrana będzie opcja Punkt końcowy bazowy. Musisz zmienić ją na Punkt końcowy zależny.
• W menu rozwijanym Zależy od wybierz odpowiedni punkt końcowy bazowy, od którego zależą dane dla punktu końcowego zależnego. W ten sposób punkt końcowy zależny będzie wywoływany dla każdego obiektu otrzymanego z punktu końcowego bazowego.
• Aby wykorzystać pole z odpowiedzi punktu końcowego bazowego, użyj makr punktu końcowego bazowego, wpisując % lub klikając .

Kroki do skonfigurowania punktu końcowego API SOAP

Musisz postępować zgodnie ze wszystkimi krokami wymienionymi w sekcji konfiguracja webhooka przychodzącego, z wyjątkiem tego kroku. Gdy Typ wiadomości jest ustawiony na XML, ADManager Plus wymaga pliku CSV Parsera odpowiedzi. Plik ten pomaga w filtrowaniu tylko wymaganych danych z odpowiedzi XML punktu końcowego. Filtrowane atrybuty mogą być następnie powiązane z atrybutami AD LDAP.

Plik CSV powinien mieć trzy kolumny, jak poniżej:

• columnName: To pożądana nazwa danych do przefiltrowania z odpowiedzi XML.
• xPath: To lokalizacja, z której dane mają zostać pobrane.
• isParameter: Jeśli ustawione na 1, stanie się atrybutem iterującym podczas powtarzających się wywołań. Na przykład, jeśli w treści wiadomości znajduje się węzeł o nazwie Page, który ma zwiększać się o jeden podczas każdego wywołania, isParameter dla Page jest ustawione na 1.

Na przykład, jak pokazano na poniższych obrazach, wartość dla columnName Worker ID, jak zaznaczone w przykładowym pliku CSV, jest wyciągana z atrybutu Worker_ID(wartość:100001), jak zaznaczone w przykładowej odpowiedzi XML. Ta wartość może być później powiązana z atrybutem AD LDAP employeeID.

Przykładowy plik CSV:

Przykładowa odpowiedź XML:

Webhook wychodzący umożliwia wysyłanie zmian w AD za pomocą ADManager Plus do aplikacji niestandardowej. Aby skonfigurować webhook wychodzący:

1. W sekcji Webhook wychodzący kliknij <Konfiguracja webhooka aplikacji niestandardowej>.
2. Kliknij + Dodaj Webhook.



3. Wprowadź nazwę i opis dla tego webhooka.
4. Zapoznaj się z dokumentacją API aplikacji niestandardowej, zdecyduj, jakie działanie ma być wykonane, i zidentyfikuj API, które jest potrzebne do wykonania tego działania.
5. Z rozwijanego menu wybierz metodę HTTP, która umożliwi Ci wykonanie żądanego działania na końcówce.
6. Wprowadź adres URL końcówki. Będzie się on różnić w zależności od danych, które chcesz przesłać do aplikacji.
   • Na przykład: Adres URL końcówki użyty do aktualizacji atrybutów użytkownika będzie różny od adresu URL końcówki użytego do aktualizacji ostatnio zmienionych haseł użytkowników. Zapoznaj się z dokumentacją API aplikacji, z którą integrujesz ADManager Plus.
7. Skonfiguruj Nagłówki, Parametry i Typ wiadomości w odpowiednim formacie na podstawie wywołania API dla działania, które chcesz wykonać.
8. Kliknij Testuj i Zapisz. Pojawi się okno pop-up z listą użytkowników i grup.
9. Wybierz żądanych użytkowników i grupy, na których ma być testowane to żądanie API, i kliknij OK. To spowoduje wywołanie w czasie rzeczywistym adresu URL końcówki, aby wykonać skonfigurowaną funkcję API na wybranych obiektach.
10. Pojawi się okno pop-up z odpowiedzią webhooka oraz szczegółami żądania. Jeśli nie możesz otrzymać odpowiedzi na żądanie API, upewnij się, że przypisane atrybuty, nagłówki, parametry i wiadomość żądania są poprawne.

Uwaga: W oknie odpowiedzi webhooka możesz zmienić typ danych lub format wartości atrybutu pobranej przez wywołanie API, korzystając z opcji edycji.

Na przykład: Format daty użyty w zintegrowanej aplikacji może być inny niż format daty użyty w ADManager Plus. Aby to rozwiązać, skorzystaj z opcji edycji w oknie odpowiedzi, aby zmodyfikować format daty.

Jak używać atrybutów wspieranych przez makra

• Możesz wpisać % lub kliknąć , aby dodać makra, które wybierzesz, w polach Wprowadź adres URL, Nagłówki i Parametry.
• Jeśli musisz dodać makra w treści wiadomości, kliknij Wybierz Makra.

Jak używać webhooków wychodzących

Po skonfigurowaniu webhooka wychodzącego do wymaganego działania, użyj go jako bloku w szablonie orkiestracji. Skonfigurowany Szablon Orkiestracji można wykonać za pomocą automatyzacji wywołanych zdarzeniami, automatyzacji zaplanowanych lub polityk automatyzacji. Może być również stosowany bezpośrednio do pożądanych użytkowników w celu wykonania sekwencji działań na nich. Zarządzanie > Zaawansowane zarządzanie > Orkiestracja.