在 Windows 服务器上设置 Qlik Data Gateway - Direct Access

您还可以通过命令行自动注册 Direct Access gateway，而无需使用 Administration 活动中心。此方法使用由 OAuth 客户端生成的短期会话令牌。

先决条件

具有创建和管理 OAuth 客户端的租户管理员权限的 API 密钥。

通过自动注册来注册网关

1. 在 Direct Access gateway 机器上生成 JSON Web Key (JWK)。此命令在 Direct Access gateway 机器上创建私钥：

   ConnectorAgent.exe qcs generate_jwk

2. 复制命令返回的 JWK。

3. 使用 API 密钥，通过租户管理 API 为网关创建 OAuth 客户端，并提供在上一步中复制的 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 客户端的同意方法设置为受信任。

   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 的 ID。

10. 创建“DAG 注册”角色。

    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 空间 ID。

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. 复制机器人 ID。

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. 复制角色 ID。

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>"