【AlteryxTips】License管理をAPIを使ってライセンス・ユーザー管理を効率化する

2024年4月23日 2024年4月23日 6分42秒

AlteryxのLicense管理をAPIを使ってライセンス・ユーザー管理を効率化する方法をご紹介します

Alteyrxのライセンス管理用のポータルサイトは2023年に新しくなっていますが、その際にLicense APIが実装されました。これにより、ライセンスの効率的な管理が可能となっています。

現時点では、大きく分けて以下６個のリソースを参照・操作（更新、削除、追加）などできます。

これらはRestAPIで提供されているため、ドキュメントを確認すれば利用可能です。Alteryxでは、ダウンロードツールを使えば利用が可能ですが、Alteryx Marketplace にてLicense APIツールが公開されており、必要最低限の労力でライセンスポータルのAPIを利用可能です。

まず、License APIを使うには、アクセストークンなどが必要となります。この取得は、ライセンスポータルにて取得します。

ライセンスポータルにアクセス後、ユーザーのメニューをクリックします。

このメニューのうち、「API Access」をクリックします。

これにより、トークンを取得する画面に遷移するので、「Generate tokens」をクリックします。

これにより、Access tokenとRefresh tokenが生成されます。後述のLicense APIツールを使う場合は、Refresh tokenがあれば事足りますので、これをコピーしてツールに貼り付けます。

ツール単体の設定方法は、アイコン200連発の方で公開中ですので、そちらを参考にしてください。

デバイスを管理します。アクティベーションされているデバイスのリスト取得、ライセンスのアクティベーション、デバイスの削除、ライセンスのRevokeなどが可能です。

Method	エンドポイント名	管理者権限	機能
GET	/v1/devices	-	アカウントに登録されているdevicesのリストを取得します
POST	/v1/devices	必要	ライセンスファイルをアクティベートします
DELETE	/v1/devices	必要	指定したdevicesを削除します
PATCH	/v1/devices	必要	指定したdevicesのライセンスをRevokeします

ライセンスポータルのお知らせを取得・追加します。

Method	エンドポイント名	管理者権限	機能
GET	/v1/annoucements	-	すべてのお知らせを取得します
POST	/v1/annoucements	必要	指定アカウントに新しいお知らせを追加します
GET	/v1/alteryx-annoucements	-	Alteryxからのお知らせを取得します

ライセンスポータルに登録されているユーザー情報を更新・取得・削除します。

Method	エンドポイント名	管理者権限	機能
GET	/v1/users/{email}	必要	指定したユーザーの詳細を取得します
PATCH	/v1/users/{email}	必要	ユーザー情報を更新します
GET	/v1/users	必要	指定したアカウントのユーザーリストを取得します
DELETE	/v1/users	必要	ライセンスポータルに登録されているユーザーをメールアドレスを指定して削除します
GET	/v1/users/current/accounts	-	ユーザーが所属しているアカウントの現在認証済みユーザーのリストを取得します

アカウントに関するエンドポイントです。情報の更新や取得ができます。

Method	エンドポイント名	管理者権限	機能
PATCH	/v1/accounts/	必要	アカウントの情報を更新します
GET	/v1/accounts/-/userCount	必要	アカウントのカウント数が取得できます