認証

Altium Identityは、Altiumの OAuth 2.0 および OpenID Connect (OIDC) に対応したIDプロバイダーです。アプリケーションはAltium Identityを通じてユーザーを認証し、そのユーザーに代わってAltium 365 APIを呼び出します。ユーザーのAltiumパスワードを直接扱うことはありません。

アプリケーションは authorization-code flow と PKCEを使用してサインインします。パブリッククライアント（デスクトップ、オンプレミス、ネイティブ、シングルページアプリ）はクライアントシークレットなしでPKCEを使用し、コンフィデンシャルクライアント（Web／サーバーバックエンド）はクライアントシークレットを追加します。すべてのリクエストとレスポンスを含む段階的なフローはGitHubで公開されています。このページでは、適切なフローを選べるように基本概念を説明します。

トークンの用語

商用のAltium 365サービスは、4つの地理的リージョンで稼働しています。

トークンの構造とクレームの詳細については、 トークン および OAuthスコープを参照してください。

サインインの流れ

Webアプリとデスクトップ／オンプレミスアプリの流れは同じです。異なるのは、認可コードを取得する how だけです（アプリがホストするリダイレクト、またはリダイレクトをホストできないアプリ向けにAltiumがホストする ActionWait パターン）。いずれの場合も、次の手順を実行します。

1. Sign in on Commercial Cloud （https://auth.altium.com）で global access tokenを取得します。ユーザーのワークスペースの一覧取得など、グローバルリソースへのアクセスに使用します。

2. Discover the user's workspaces をグローバルトークンで実行します。

3. Exchange the global token for a workspace access tokenを、ワークスペースに対応するエンドポイント（商用またはGovCloud — 下記参照）で実行します。

4. Call the Altium 365 API をワークスペーストークンで実行し、そのトークンを発行したエンドポイントで更新します。

sequenceDiagram
    participant App
    participant Identity as Altium Identity
    participant API as Altium 365 API
    App->>Identity: 1. Sign in on auth.altium.com (openid profile) + PKCE
    Identity-->>App: global access token
    App->>API: 2. Discover workspaces (global token)
    API-->>App: workspaces (+ location)
    App->>Identity: 3. Exchange for a workspace token
    Identity-->>App: workspace access token (+ refresh token)
    App->>API: 4. API calls (workspace access token)

通常、アプリは複数のトークンを同時に保持します。1つのグローバルトークンと、使用中のワークスペースごとに1つのワークスペーストークンです。各トークンは、それぞれを発行したエンドポイントで更新されます。

商用クラウドとGovCloud

Altium 365は、厳密に分離された2つの環境で稼働しています。

• Commercial Cloud （auth.altium.com）— デフォルトの環境です。

• GovCloud （auth.365-gov.altium.com）— ITAR対象／規制対象のワークスペース向けの隔離された環境です。

トークンの発行者（iss）は、そのトークンを発行した環境を示します。2つの環境のトークンを相互に使用することはできません。Govトークンは商用サービスで拒否され、商用トークンはGovCloudで拒否されます。GovCloudは two-token model によってこの分離を徹底します。Govワークスペーストークンには、GovCloudに紐付ける secure マーカーが含まれます。商用クラウドで一度サインインした後、各ワークスペースが属する環境でグローバルトークンをそれぞれのワークスペーストークンに交換します。

どのフローを使用すればよいですか？

クライアントライブラリ

フローを自分で実装する必要はありません。Altiumは、言語に依存しない共通仕様に基づいて構築され、共通の適合性テストスイートで検証されたオープンソースライブラリを保守しています。

詳細情報

• Altium 365 Auth — 完全なドキュメントとライブラリ（GitHub）

• Altium Identity — 連携仕様