Настройка Шлюз данных Qlik — прямой доступ на сервере Windows

Вы также можете зарегистрировать Direct Access Gateway автоматически из командной строки, не используя центр активности Администрирование. Этот метод использует краткосрочный токен сеанса, сгенерированный клиентом OAuth.

Предварительные требования

Ключ API с правами администратора клиента для создания клиентов OAuth и управления ими.

Регистрация шлюза с помощью автоматической регистрации

1. Сгенерируйте JSON Web Key (JWK) на машине Direct Access Gateway. Эта команда создает закрытые ключи на машине Direct Access Gateway:

   ConnectorAgent.exe qcs generate_jwk

2. Скопируйте JWK, возвращенный командой.

3. Используя ключ API, создайте клиент OAuth для шлюза через API администратора клиента, указав JWK, скопированный на предыдущем шаге.

   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. Скопируйте значение client_id, возвращенное в ответе.

5. Установите для метода согласия клиента OAuth значение trusted.

   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. Создайте утверждение регистрации на компьютере Direct Access Gateway:

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

7. Запросите токен доступа. Это также запускает автоматическое создание учетной записи пользователя бота, используемой шлюзом.

   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. Найдите автоматически созданного пользователя-бота.

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

9. Скопируйте идентификатор my-bot-client.

10. Создайте роль "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. Назначьте пользователю-боту роли уровня клиента.

    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. Получить пространство шлюза прямого доступа.

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

13. Скопируйте идентификатор пространства Direct Access Gateway.

14. Добавьте пользователя-бота в пространство с разрешением Может редактировать.

    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. Если срок действия существующего утверждения истек, сгенерируйте новое.

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

16. Зарегистрируйте шлюз:

    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>

Удаление автоматически зарегистрированного шлюза

Выполните следующие шаги, чтобы отменить регистрацию шлюза, зарегистрированного с помощью описанного выше автоматического метода на основе токена сеанса. Эти шаги также удаляют клиент OAuth, пользователя-бота и роль, созданные для него.

1. Сгенерируйте утверждение, как описано на шестом шаге раздела «Автоматическая регистрация шлюза с использованием сессионного токена».

2. Удалите шлюз:

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

3. Удалите JWK.

   ConnectorAgent.exe qcs delete_jwk

4. Найдите учетную запись пользователя-бота, созданную для шлюза.

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

5. Скопируйте идентификатор бота.

6. Удалить эту учетную запись бота.

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

7. Найдите роль «DAG Registration», созданную для шлюза.

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

8. Скопируйте идентификатор роли.

9. Удалить эту роль.

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

10. Удалите клиент OAuth.

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