Instellen van Qlik Gegevensgateway - Directe toegang op een Windows server

U kunt Direct Access gateway ook automatisch registreren via de opdrachtregel, zonder het Beheer-activiteitencentrum te gebruiken. Deze methode maakt gebruik van een kortlevende sessietoken gegenereerd vanuit een OAuth-client.

Vereisten

Een API-sleutel met tenant-beheerdersrechten om OAuth-clients te maken en te beheren.

De gateway registreren met automatische registratie

1. Genereer een JSON Web Key (JWK) op de Direct Access gateway machine. Deze opdracht maakt privésleutels aan op de Direct Access gateway machine:

   ConnectorAgent.exe qcs generate_jwk

2. Kopieer de door de opdracht geretourneerde JWK.

3. Maak met behulp van de API-sleutel via de tenant-admin-API een OAuth-client voor de gateway, waarbij u de JWK opgeeft die u in de vorige stap hebt gekopieerd.

   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. Kopieer de client_id-waarde die in de respons is geretourneerd.

5. Stel de toestemmingsmethode van de OAuth-client in op vertrouwd.

   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. Maak een registratie-assertie aan op de Direct Access gateway-machine:

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

7. Vraag een toegangstoken aan. Dit activeert ook de automatische aanmaak van het bot-gebruikersaccount dat door de gateway wordt gebruikt.

   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. Zoek de automatisch aangemaakte botgebruiker op.

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

9. Kopieer de ID van my-bot-client.

10. Maak een rol "DAG Registration" aan.

    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. Wijs rollen op tenantniveau toe aan de botgebruiker.

    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. Haal de Gateway voor directe toegang-ruimte op.

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

13. Kopieer de Direct Access Gateway-space-id.

14. Voeg de botgebruiker toe aan de ruimte met de machtiging Kan bewerken.

    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. Als de bestaande assertion is verlopen, genereer dan een nieuwe.

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

16. Registreer de gateway:

    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>

Een automatisch geregistreerde gateway verwijderen

Gebruik de volgende stappen om de registratie van een gateway ongedaan te maken die is geregistreerd met de hierboven beschreven automatische, op sessietokens gebaseerde methode. Deze stappen verwijderen ook de OAuth-client, botgebruiker en rol die hiervoor zijn aangemaakt.

1. Genereer een assertie, zoals beschreven in stap zes van Automatische gatewayregistratie met behulp van een sessietoken.

2. Verwijder de gateway:

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

3. Verwijder de JWK.

   ConnectorAgent.exe qcs delete_jwk

4. Zoek het bot-gebruikersaccount op dat voor de gateway is aangemaakt.

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

5. Kopieer de bot-id.

6. Verwijder dit bot-gebruikersaccount.

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

7. Zoek de rol “DAG Registration” op die voor de gateway is gemaakt.

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

8. Kopieer de rol-id.

9. Verwijder deze rol.

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

10. Verwijder de OAuth-client.

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