Authentifizierung

Altium Identity ist der OAuth 2.0 und OpenID Connect (OIDC) -Identitätsanbieter von Altium. Ihre Anwendung authentifiziert einen Benutzer über Altium Identity und ruft anschließend in dessen Namen die Altium 365 API auf — dabei verarbeitet sie niemals das Altium-Passwort des Benutzers.

Anwendungen melden sich mit authorization-code flow und PKCE an. Öffentliche Clients (Desktop-, On-Premises-, native und Single-Page-Anwendungen) verwenden PKCE ohne Client-Secret; vertrauliche Clients (Web-/Server-Backends) verwenden zusätzlich ein Client-Secret. Die schrittweisen Abläufe mit sämtlichen Anfragen und Antworten finden Sie auf GitHub — diese Seite erläutert die Konzepte, damit Sie wissen, welchen Weg Sie wählen sollten.

Token-Begriffe

Das kommerzielle Altium 365-Angebot wird in vier geografischen Regionen betrieben:

Den vollständigen Aufbau eines Tokens und seiner Claims finden Sie unter Tokens und OAuth-Scopes.

Der Anmeldeablauf

Der Ablauf ist für Web- und Desktop-/On-Premises-Anwendungen gleich — nur how Sie den Autorisierungscode erhalten, unterscheidet sich (über eine von Ihrer Anwendung gehostete Weiterleitung oder das von Altium gehostete ActionWait Muster für Anwendungen, die keine solche Weiterleitung hosten können). In jedem Fall:

1. Sign in on Commercial Cloud (https://auth.altium.com), um ein global access token zu erhalten. Verwenden Sie es für globale Ressourcen, etwa zum Auflisten der Workspaces des Benutzers.

2. Discover the user's workspaces mit dem globalen Token.

3. Exchange the global token for a workspace access token, am Endpunkt, der zum Workspace passt (Commercial oder GovCloud — siehe unten).

4. Call the Altium 365 API mit dem Workspace-Token und aktualisieren Sie es an dem Endpunkt, der es ausgestellt hat.

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)

Eine Anwendung hält üblicherweise mehrere Tokens gleichzeitig — ein globales Token sowie ein Workspace-Token pro verwendetem Workspace. Jedes wird an seinem jeweiligen ausstellenden Endpunkt aktualisiert.

Commercial Cloud und GovCloud

Altium 365 betreibt zwei strikt getrennte Umgebungen:

• Commercial Cloud (auth.altium.com) — die Standardumgebung.

• GovCloud (auth.365-gov.altium.com) — eine isolierte Umgebung für ITAR-/regulierte Workspaces.

Der Aussteller eines Tokens (iss) gibt an, welche Umgebung es erstellt hat. Die Tokens sind niemals austauschbar: Ein Gov-Token wird von Commercial-Diensten abgelehnt, und ein Commercial-Token wird von GovCloud abgelehnt. GovCloud erzwingt dies mit einem two-token model — ein Gov-Workspace-Token enthält eine secure Kennzeichnung, die es an GovCloud bindet. Sie melden sich einmal bei Commercial Cloud an und tauschen anschließend Ihr globales Token gegen das jeweilige Workspace-Token in der Umgebung aus, zu der der betreffende Workspace gehört.

Welchen Ablauf benötige ich?

Client-Bibliotheken

Sie müssen den Ablauf nicht selbst implementieren. Altium pflegt Open-Source-Bibliotheken, die auf einer gemeinsamen sprachunabhängigen Spezifikation basieren und durch eine gemeinsame Konformitätstestsuite validiert werden:

Mehr erfahren

• Altium 365 Auth — vollständige Dokumentation und Bibliotheken (GitHub)

• Altium Identity — Integrationsspezifikation