Choose an SDK
Sudomimus SDKs are strongly typed clients generated from the public OpenAPI 3.1 contracts in sudomimus/sudomimus-spec. They wrap the raw HTTPS APIs with request and response types, JSON serialization, client-auth signing, token parsing, Session JWKS caching, signature verification helpers, and structured API errors.
Use the SDK when you are building an application integration. Use the API reference when you need the exact wire contract for debugging, unsupported languages, or generated clients of your own.
API Coverage
Section titled “API Coverage”| API | SDK responsibility |
|---|---|
| Connect API | Start browser login inquiries, status-poll them, redeem them for tokens, and fetch application metadata. |
| Session API | Rotate refresh tokens, introspect sessions, log out one session, or revoke all sessions for a subject. |
| Device API | Start device-code authorization and exchange the device code after user approval. |
| Native API | Exchange Steam tickets or AccessKey credentials for ordinary Sudomimus tokens. |
| Token helpers | Parse and verify Sudomimus access and refresh JWTs. |
Choose A Language
Section titled “Choose A Language”Package Model
Section titled “Package Model”Each SDK package follows one Sudomimus API surface. Install the package for the flow you start with, then add the Session package for refresh-token lifecycle work after tokens are issued.
- Connect is the usual web-application login flow. It needs your application’s client-auth private key because
/establishrequires client-auth signing. - Device is for public clients such as CLIs, launchers, TV apps, and terminals. It does not require a client secret.
- Native is for native credentials such as Steam Web API auth tickets and Sudomimus AccessKeys.
- Session is for everything that happens after initial issue: refresh, introspection, logout, and revoke-all.
- Token is for services that only verify access or refresh tokens and do not call an API.
The API walkthroughs still explain the underlying protocol: