# Altium Authentication

> OAuth 2.0 / OpenID Connect client libraries and specification for Altium 365. Covers the Altium-specific parts of the flow: the ActionWait desktop sign-in, workspace token exchange, GovCloud (`secure=1`) and AES (on-prem) installations, refresh and revocation.

The integration specification is normative; the guides explain the flows; each library page is its package README.

## Overview

- [Altium Authentication](https://altiumdeveloper.github.io/altium-auth/index.md): Client libraries and specification for Altium 365 authentication.

## Guides

- [Authentication](https://altiumdeveloper.github.io/altium-auth/guides/overview.md): Endpoints, key terms, and the recommended authentication flow.
- [Authenticate a web or server application](https://altiumdeveloper.github.io/altium-auth/guides/web-and-server-apps.md): The authorization-code redirect flow for confidential clients.
- [Authenticate a desktop application](https://altiumdeveloper.github.io/altium-auth/guides/desktop-apps.md): Browser sign-in with PKCE over the ActionWait long-poll, for public clients.
- [GovCloud considerations](https://altiumdeveloper.github.io/altium-auth/guides/govcloud.md): Commercial vs Gov and the secure=1 two-token model.
- [AES (on-prem) considerations](https://altiumdeveloper.github.io/altium-auth/guides/aes.md): Customer-hosted installations of Altium Enterprise Server.
- [Access token claims](https://altiumdeveloper.github.io/altium-auth/guides/token-claims.md): What is inside an access token: iss, workspaceId, secure, scopes.
- [Register your application](https://altiumdeveloper.github.io/altium-auth/guides/register-your-application.md): Client types, redirect URLs, and credentials.

## Libraries

- [@altium-developer/altium-auth](https://altiumdeveloper.github.io/altium-auth/libraries/typescript.md): @altium-developer/altium-auth on npm: installation, quick start, and API reference.
- [Altium.Auth](https://altiumdeveloper.github.io/altium-auth/libraries/dotnet.md): Altium.Auth on NuGet: installation, quick start, PowerShell use, and API reference.
- [altium-auth (Python)](https://altiumdeveloper.github.io/altium-auth/libraries/python.md): altium-auth on PyPI: installation, quick start, and API reference.

## Specification

- [Altium Identity Integration Specification](https://altiumdeveloper.github.io/altium-auth/specification/spec.md): The normative Altium delta over standard OAuth 2.0 / OIDC that every library implements.
- [Conformance vectors](https://altiumdeveloper.github.io/altium-auth/specification/conformance.md): The language-neutral vectors every library runs, and their matchers.

## Optional

- [Everything on one page](https://altiumdeveloper.github.io/altium-auth/llms-full.txt): all pages above, concatenated