VS Code APS エクステンション v3 利用 – 3-legged(PKCE)アクセス

VS Code APS エクステンションで 3-legged 認証フロー(Get a 3-Legged Token with Authorization Code Grant (PKCE) )を利用をしたアクセスをご紹介します。

PKCE(Proof Key for Code Exchange)を用いた 3-legged 認証フローは、デスクトップやモバイル デバイス上でネイティブに動作するアプリ、つまりアプリの認証情報を保護できないようなシナリオで、アプリのセキュリティを強化する目的で利用が推奨されるものです。

APS エクステンションを使った基本的な手順は、VS Code APS エクステンション v3 利用 – 3-legged アクセス でご案内した内容と同じです。ただし、いくつかの点で異なる点がありますので、ここでは相違点に絞ってご案内したいと思います。

おおまかな相違点は次のとおりです。

  • 使用するアプリタイプ
  • APS エクステンション環境の記述
  • APS エクステンションのサインイン タイプ

  • 使用するアプリタイプ

PKCE(Proof Key for Code Exchange)を用いた 3-legged 認証フローを使用する場合、デベロッパーハブで作成するアプリ タイプは ”Desktop, Mobile, Single-Page App” である必要があります。

  • ”Desktop, Mobile, Single-Page App” タイプでは、PKCE を使用するパブリック Client ID のみを使用するタイプであるため(Client Secret を使用しないタイプであるため)、有料 API(Automation API、Model Derivative API、Flow Graph Engine API、Reality Capture API)を選択・利用出来ないように制限されています。
    ”Traditional Web App” や ”Server-to-Server App” タイプでは Client Secret も使用されるため、有料 API が利用可能です。なお、課金対象になっている AEC Data Model API および Manufacturing Data Model API については、製品のサブスクリプションの一部として提供されているため、前述の有料 API とは扱いが異なります。(同様の制限は適用されません。)

  • APS エクステンション環境の記述

Client Secret が不要な PKCE(Proof Key for Code Exchange)を用いた 3-legged 認証フローでは、VS Code APS エクステンション v3 利用 – セットアップ でご紹介した「環境」の設定にも Client Secret の記入は不要です。

settings.json の内容が編集する際には、”clientSecret“ の指定は不要です。次の例は、VS Code APS Extension Test PKCE の名前で作成した “Desktop, Mobile, Single-Page App” アプリを環境に設定するものです。

...
"region": "US"
},
{
"title":"VS Code APS Extension Test PKCE",
"clientId":"▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯",
"region": "US"
},
{
"title": "Viewer 2-legged Basic Process",
...

  • APS エクステンションのサインイン タイプ

APS サイドバーの Data & Derivatives (User) ペインにある [Sign in to APS] ボタンをクリックしてサインインする場合には、「3-legged OAuth with PKCE」を選択してください。