Windows サーバーで Qlik Data Gateway - 直接アクセス を設定する

管理 アクティビティ センターを使用せずに、コマンド ラインから Direct Access gateway を自動的に登録することもできます。このメソッドは、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 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. Direct Access Gateway のスペースを取得します。

    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. セッション トークンを使用した自動ゲートウェイ登録のステップ 6 の説明に従って、アサーションを生成します。

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