QlikTips: Qlik Cloud REST APIでユーザー登録(Node.js)

Qlik Cloud REST API で
ユーザー登録 (Node.js)
Qlik Tips
2025/04/22

Qlik Cloud REST API でユーザー登録
Qlik Cloud REST API を利用すれば、 IdP として Qlik ID または外部 IdP を使用しているそれぞれ
の場合について、ユーザーが初めてログインする前に
o ユーザーへ招待メールを送信
o ユーザー情報の登録
o ユーザーへのライセンス割り当て
o ユーザーへのスペースアクセス権割り当て
などの作業が行えます
オンラインヘルプ「 REST APIs 」 - https://qlik.dev/apis/rest/
o Qlik は、 Qlik Cloud のテナントを監視・管理するための REST API を提供しています。これらの API
は、テナント内の * ほとんど * の機能を構成するための方法を提供し、プログラムによるデプロイ、
CI/CD 、モニタリングなどを可能にします
このスライドでは、上記の処理を Node.js で実装したものを紹介します
o 認証方式として API キーまたは OAuth を利用 (※Authorization ヘッダーの Bearer トークンに利用 )
2

いちおう、 qlik-cli はあるものの ...
Qlik Cloud REST API の呼び出しを Go 言語で実装したコマンドラインツール「 qlik-cli 」
• https://qlik.dev/toolkits/qlik-cli/
• 認証 IdP としてデフォルトの「 Qlik ID 」を使用している場合に必要な「ユーザー招待」の API(※
招待メールが Qlik から送信されてくる ) が実装されていない !
• 外部 IdP を使用している場合は「ユーザー招待」そのものが存在しないので、自前で何らかの招
待メールのようなものを送信する必要があるが、 qlik-cli には無理 !
• 複数テナント場合に context の切り替えがいちいち必要 !
• qlik-cli のコマンドを起動したり、 qlik-cli に渡す JSON データや実行結果の JSON データを処理す
るためには、結局 PowerShell やその他のプログラミング言語を利用する必要が出てくるので、逆
に実装・保守の手間が増える !
• 細かなエラー処理 (REST API のエラーコードなど ) を行うのが難しい !
o 例 : Rate limiting など
3
参考 : Rate limiting
https://qlik.dev/apis/rest/#rate-limiting
To ensure fair usage, Qlik implements rate limiting on API requests. Be sure to handle rate limit errors (HTTP 429) in your applications.
https://qlik.dev/apis/rest/rate-limiting/
In general, rate limits for published APIs (documented on qlik.dev) are evaluated on a per tier, per user, per tenant basis.

認証 IdP が Qlik ID の
場合
4

Node.js での実装および処理順 - 認証 IdP が Qlik ID の場
合
• REST API の呼び出しには、 fetch 関数を利用
• REST API の呼び出し時に、 Authorization ヘッダーの Bearer トークンが必要
o API キーの場合は、それをそのまま利用
o OAuth の場合は、いったんアクセストークンを取得する REST API を呼び出し、取得したアク
セストークンを利用
• ユーザーへ招待メールを送信 (※ 「招待中のユーザー情報」が自動登録される )
o 招待中のユーザーは、管理コンソールのユーザー一覧には「保留中の招待」のユーザーとして表示される
• 「招待中ユーザーの仮の IdP サブジェクト」を基に、そのユーザーへのライセンス割り当て
o 仮の IdP サブジェクトは、ユーザーが実際にログインした際に正式なものに更新・同期される
• 「招待中ユーザーのテナント固有ユーザー ID 」を基に、そのユーザーへのスペースアクセス権割
り当て
o ユーザー ID は、テナントにユーザー登録された時点で決定され、以降変わらない
o 招待中のユーザーは、管理コンソールのスペースのメンバー一覧にはまだ表示されず、ログイン実施後に
表示されるようになる
5

Node.js での実装 - 処理の流れ
• Bearer トークンを取得し、ユーザーに招待メールを送信し、ユーザーにライセンスを付与し
( 例 :Analyzer) 、ユーザーにあるスペースへのアクセス権 ( 例 : 共有スペースの ID を指定 ) を付与
6

Bearer トークン (API キー ) の取得、ユーザーの招待
7

Bearer トークン (OAuth アクセストークン ) の取得の場合
8

ライセンスおよびスペースアクセス権の割り当て
9

外部 IdP を利用する場
合
10

Node.js での実装および処理順 - 外部 IdP を利用する場合
• REST API の呼び出しには、 fetch 関数を利用
• REST API の呼び出し時に、 Authorization ヘッダーの Bearer トークンが必要
o API キーの場合は、それをそのまま利用
o OAuth の場合は、いったんアクセストークンを取得する REST API を呼び出し、取得したア
クセストークンを利用
• 新規に「ユーザー情報」を登録
o 事前にユーザー情報の登録を自前で行う必要があり、その際に必要な仮の IdP サブジェクトを生成する
ために、 uuid パッケージを利用 (https://www.npmjs.com/package/uuid)
• そのユーザーへのライセンス割り当て
o 仮の IdP サブジェクトは、ユーザーが実際にログインした際に正式なものに更新・同期される
• 「ユーザーのテナント固有ユーザー ID 」を基に、そのユーザーへのスペースアクセス権割り当
て
o ユーザー ID は、テナントにユーザー登録された時点で決定され、以降変わらない
• ユーザーへ招待メールを自前で送信
o ユーザーの招待機能は存在しないので、ユーザー宛てに自前でメールを送信するために nodemailer
パッケージを利用 (https://www.npmjs.com/package/nodemailer)
11

Node.js での実装 - 処理の流れ
• Bearer トークンを取得し、ユーザーを登録し、ユーザーにライセンスを付与し ( 例 :Full User) 、ユーザーに
あるスペースへのアクセス権 ( 例 : 共有スペースの ID を指定 ) を付与し、ユーザーに招待メールを送信
12

Bearer トークン (API キー ) の取得、ユーザーの登録
13

Bearer トークン (OAuth アクセストークン ) の取得の場合
14

ライセンスおよびスペースアクセス権の割り当て
15

API キーの作成
1. テナント管理者で Qlik Cloud にログインし、管理コンソールで「 REST API 用
ユーザー」に「 Developer 」権限を付加
2. 管理コンソールの設定ページで API キーを有効にし、有効期限なども設定
3. Qlik Cloud に「 Developer 」権限のあるユーザーでログイン
4. ユーザーの「プロファイル設定」ページにアクセスし、管理  API キー  新
規キーの作成で API キーを作成したら、その文字列を大切に保管

OAuth 構成の作成
1. テナント管理者で Qlik Cloud にログインし、管理コンソールの OAuth 設定ページで [ 新規作
成 ] ボタンをクリックし、クライアントタイプを「ウェブ」、名前、範囲を「 admin_classic 」、
「マシンツーマシン (M2M) を許可」を有効
2. [ 作成 ] ボタンで OAuth 構成を作成し、「クライアント ID 」と「クライアントシークレット」
文字列を大切に保管し、同期方法を「信頼済み」に変更
3. OAuth の名前でユーザーが作成される (※ テナント管理者のため、自動的に Full User に昇格 )

サンプルコードおよび Qlik Cloud REST API
[ サンプルコード (GitHub)]
https://github.com/ttcodegear/QlikCloudRESTAPI
[Supported authentication methods]
https://qlik.dev/apis/rest/#authentication
[Generate your first API key]
https://qlik.dev/authenticate/api-key/generate-your-first-api-key/
[Create a M2M OAuth2 client]
https://qlik.dev/authenticate/oauth/create/create-oauth-client/
[Invite one or more users by email address]
https://qlik.dev/apis/rest/users/#post-v1-users-actions-invite
Rate limit Tier 2 (100 requests per minute)
[Create user ]
https://qlik.dev/apis/rest/users/#post-v1-users
[Assigns license access to the given users]
https://qlik.dev/apis/rest/licenses/#post-v1-licenses-assignments-actions-add
[Assign a user or group to a space]
https://qlik.dev/apis/rest/spaces/#post-v1-spaces-spaceId-assignments
20

QlikTips: Qlik Cloud REST APIでユーザー登録(Node.js)

More Related Content

Similar to QlikTips: Qlik Cloud REST APIでユーザー登録(Node.js) (20)

More from QlikPresalesJapan (20)

QlikTips: Qlik Cloud REST APIでユーザー登録(Node.js)