Konfiguracja Brama danych Qlik — dostęp bezpośredni na serwerze Windows

Możesz również zarejestrować Brama dostępu bezpośredniego automatycznie z wiersza poleceń, bez korzystania z centrum aktywności Administrowanie.\ Ta metoda wykorzystuje krótkotrwały token sesji wygenerowany na podstawie klienta OAuth.

Wymagania wstępne

Klucz API z uprawnieniami administratora dzierżawy do tworzenia klientów OAuth i zarządzania nimi.

Rejestracja bramy za pomocą automatycznej rejestracji

1. Wygeneruj klucz JSON Web Key (JWK) na maszynie Brama dostępu bezpośredniego. To polecenie tworzy klucze prywatne na maszynie Brama dostępu bezpośredniego:

   ConnectorAgent.exe qcs generate_jwk

2. Skopiuj klucz JWK zwrócony przez polecenie.

3. Używając klucza API, utwórz klienta OAuth dla bramy za pośrednictwem API administratora dzierżawy, podając JWK skopiowany w poprzednim kroku.

   curl "https://<tenant-url>/api/v1/oauth-clients" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <api-key>' -d '{"appType":"web","clientName":"<client-name>","description":"","allowedScopes":["admin.direct-access-gateways:register_gateway","admin.direct-access-gateways:delete_gateway"],"allowedAuthMethods":["private_key_jwt"],"publicKeys":[<jwk>],"allowedGrantTypes":["client_credentials"]}'

4. Skopiuj wartość client_id zwróconą w odpowiedzi.

5. Ustaw metodę wyrażania zgody klienta OAuth na zaufaną.

   curl "https://<tenant-url>/api/v1/oauth-clients/<client-id>/connection-configs/me" -X PATCH -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <api-key>' -d '[{"op":"replace","path":"/consentMethod","value":"trusted"}]'

6. Utwórz asercję rejestracji na maszynie Brama dostępu bezpośredniego:

   ConnectorAgent.exe qcs generate_registration_assertion --tenant_url <tenant-url> --client-id <client-id>

7. Zażądaj tokenu dostępu. Powoduje to również automatyczne utworzenie konta użytkownika bota używanego przez bramę.

   curl "https://<tenant-url>/oauth/token" -X POST -H 'content-type: application/x-www-form-urlencoded' -d "grant_type=client_credentials" -d "client_id=<client-id>" -d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" -d "client_assertion=<assertion>" -d "scope=admin.direct-access-gateways:register_gateway admin.direct-access-gateways:delete_gateway"

8. Wyszukaj automatycznie utworzonego użytkownika-bota.

   curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <API-key>'

9. Skopiuj identyfikator my-bot-client.

10. Utwórz rolę „DAG Registration”.

    curl "https://<tenant-url>/api/v1/roles" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H  'authorization: Bearer API-key' -d '{"name":"DAG Registration","description":"Role for registering a gateway","assignedScopes":["admin.direct-access-gateways:register_gateway", "admin.direct-access-gateways:delete_gateway"]}'

11. Przypisz role na poziomie dzierżawy użytkownikowi bota.

    curl "https://<tenant-url>/api/v1/users/<bot-user-ID>" -X PATCH  -H 'accept: application/json' -H 'content-type: application/json' -H  'authorization: Bearer <API-key>' -d ' [ { "op": "replace", "path": "/assignedRoles", "value": [ { "name": "DAG Registration" } ] } ]'

12. Pobierz przestrzeń Bramy dostępu bezpośredniego.

    curl "https://<tenant-url>/api/v1/spaces" -H  'authorization: Bearer <API-key>'

13. Skopiuj identyfikator przestrzeni Direct Access Gateway.

14. Dodaj użytkownika-bota do przestrzeni z uprawnieniem Może edytować.

    curl "https://<tenant-url>/api/v1/spaces/<DAG-space-ID>/assignments" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H  'authorization: Bearer <API-key>' -d '{"assigneeId": "<Bot-user-ID>","roles": ["consumer","dataconsumer","producer"], "type": "user"}'

15. W przypadku, gdy istniejąca asercja wygasła, wygeneruj nową.

    ConnectorAgent.exe qcs generate_registration_assertion --tenant_url <tenant-url> --client-id <client-ID>

16. Zarejestruj bramę:

    ConnectorAgent.exe qcs register_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --gateway_description <gateway-description> --space_name <space-name> --client-id <client-ID> --assertion <assertion>

Usuwanie automatycznie zarejestrowanej bramy

Wykonaj poniższe kroki, aby wyrejestrować bramę, która została zarejestrowana przy użyciu opisanej powyżej automatycznej metody opartej na tokenie sesji. Kroki te usuwają również klienta OAuth, użytkownika bota oraz rolę, które zostały dla niego utworzone.

1. Wygeneruj asercję zgodnie z opisem w kroku szóstym sekcji Automatyczna rejestracja bramy przy użyciu tokena sesji.

2. Usuń bramę:

   ConnectorAgent.exe qcs delete_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --client-id <client-ID> --assertion <assertion>

3. Usuń JWK.

   ConnectorAgent.exe qcs delete_jwk

4. Wyszukaj konto użytkownika bota, które zostało utworzone dla bramy.

   curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <api-key>'

5. Skopiuj identyfikator bota.

6. Usuń to konto użytkownika bota.

   curl -X DELETE "https://<tenant-url>/api/v1/users/<bot-user-ID>" -H "Authorization: Bearer <api-key>"

7. Wyszukaj rolę „DAG Registration”, która została utworzona dla bramy.

   curl "https://<tenant-url>/api/v1/roles?limit=1&filter=(name eq \"DAG Registration\")" -H "Authorization: Bearer <api-key>"

8. Skopiuj identyfikator roli.

9. Usuń tę rolę.

   curl -X DELETE "https://<tenant-url>/api/v1/roles/<role-ID>" -H "Authorization: Bearer <api-key>"

10. Usuń klienta OAuth.

    curl -X DELETE "https://<tenant-url>/api/v1/oauth-clients/<client-ID>" -H "qlik-confirm-delete: <client-ID>" -H "Authorization: Bearer <api-key>"