Konfigurera Qlik Data Gateway – direktåtkomst på en Windows-server

Du kan också registrera Gateway med direktåtkomst automatiskt från kommandoraden, utan att använda aktivitetscentret Administration. Denna metod använder en kortlivad sessionstoken som genererats från en OAuth-klient.

Förutsättningar

En API-nyckel med behörighet som klientorganisationsadministratör för att skapa och hantera OAuth-klienter.

Registrera gatewayen med automatisk registrering

1. Generera en JSON Web Key (JWK) på Gateway med direktåtkomst-maskinen. Detta kommando skapar privata nycklar på Gateway med direktåtkomst-maskinen:

   ConnectorAgent.exe qcs generate_jwk

2. Kopiera den JWK som returneras av kommandot.

3. Använd API-nyckeln för att skapa en OAuth-klient för gatewayen via klientorganisationens admin-API och ange den JWK du kopierade i föregående steg.

   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. Kopiera värdet för client_id som returneras i svaret.

5. Ställ in OAuth-klientens samtyckesmetod på betrodd.

   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. Skapa en registreringsförsäkran på Gateway med direktåtkomst-maskinen:

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

7. Begär en åtkomsttoken. Detta utlöser också automatiskt skapande av det bot-användarkonto som används av gatewayen.

   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. Leta upp den automatiskt skapade botanvändaren.

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

9. Kopiera ID:t för my-bot-client.

10. Skapa en "DAG Registration"-roll.

    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. Tilldela roller på klientorganisationsnivå till botanvändaren.

    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. Hämta utrymmet för Gateway med direktåtkomst.

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

13. Kopiera utrymmes-ID för Direct Access Gateway.

14. Lägg till botanvändaren i ytan med behörigheten Kan redigera.

    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. Om den befintliga assertionen har löpt ut, generera en ny.

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

16. Registrera gatewayen:

    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>

Ta bort en automatiskt registrerad gateway

Använd följande steg för att avregistrera en gateway som registrerades med den automatiska, sessionstokenbaserade metoden som beskrivs ovan. Dessa steg tar även bort OAuth-klienten, botanvändaren och rollen som skapades för den.

1. Generera en assertion enligt beskrivningen i steg sex i Automatisk gatewayregistrering med en sessionstoken.

2. Ta bort gatewayen:

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

3. Ta bort JWK:n.

   ConnectorAgent.exe qcs delete_jwk

4. Leta upp botanvändarkontot som skapades för gatewayen.

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

5. Kopiera bot-ID:t.

6. Ta bort detta botanvändarkonto.

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

7. Leta upp rollen ”DAG Registration” som skapades för gatewayen.

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

8. Kopiera roll-ID:t.

9. Ta bort den här rollen.

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

10. Ta bort OAuth-klienten.

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